-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# [4.0.0](v3.0.1...v4.0.0) (2020-11-05) ### Documentation * more use cases in demo/ ([17e19d2](17e19d2)) ### Features * is directive ([f8c2b81](f8c2b81)) * JSSanSourceFile ([549531e](549531e)) * SanFileParser ([50c7387](50c7387)) * support s-is, see baidu/san#533 ([df78670](df78670)) ### BREAKING CHANGES * 不再支持 getComponentType * SanSourceFile ComponentInfo 类型有变
- Loading branch information
1 parent
17e19d2
commit b144ffe
Showing
71 changed files
with
6,143 additions
and
1,099 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
168 changes: 72 additions & 96 deletions
168
docs/classes/_src_models_component_info_.componentinfoimpl.html
Large diffs are not rendered by default.
Oops, something went wrong.
151 changes: 87 additions & 64 deletions
151
docs/classes/_src_models_component_info_.dynamiccomponentinfo.html
Large diffs are not rendered by default.
Oops, something went wrong.
472 changes: 472 additions & 0 deletions
472
docs/classes/_src_models_component_info_.jscomponentinfo.html
Large diffs are not rendered by default.
Oops, something went wrong.
122 changes: 57 additions & 65 deletions
122
docs/classes/_src_models_component_info_.typedcomponentinfo.html
Large diffs are not rendered by default.
Oops, something went wrong.
286 changes: 286 additions & 0 deletions
286
docs/classes/_src_models_component_reference_.componentreference.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,286 @@ | ||
<!doctype html> | ||
<html class="default no-js"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
<title>ComponentReference | san-ssr</title> | ||
<meta name="description" content="Documentation for san-ssr"> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"> | ||
<link rel="stylesheet" href="../assets/css/main.css"> | ||
</head> | ||
<body> | ||
<header> | ||
<div class="tsd-page-toolbar"> | ||
<div class="container"> | ||
<div class="table-wrap"> | ||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> | ||
<div class="field"> | ||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> | ||
<input id="tsd-search-field" type="text" /> | ||
</div> | ||
<ul class="results"> | ||
<li class="state loading">Preparing search index...</li> | ||
<li class="state failure">The search index is not available</li> | ||
</ul> | ||
<a href="../index.html" class="title">san-ssr</a> | ||
</div> | ||
<div class="table-cell" id="tsd-widgets"> | ||
<div id="tsd-filter"> | ||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> | ||
<div class="tsd-filter-group"> | ||
<div class="tsd-select" id="tsd-filter-visibility"> | ||
<span class="tsd-select-label">All</span> | ||
<ul class="tsd-select-list"> | ||
<li data-value="public">Public</li> | ||
<li data-value="protected">Public/Protected</li> | ||
<li data-value="private" class="selected">All</li> | ||
</ul> | ||
</div> | ||
<input type="checkbox" id="tsd-filter-inherited" checked /> | ||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> | ||
<input type="checkbox" id="tsd-filter-externals" checked /> | ||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label> | ||
<input type="checkbox" id="tsd-filter-only-exported" /> | ||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> | ||
</div> | ||
</div> | ||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
<div class="tsd-page-title"> | ||
<div class="container"> | ||
<ul class="tsd-breadcrumb"> | ||
<li> | ||
<a href="../globals.html">Globals</a> | ||
</li> | ||
<li> | ||
<a href="../modules/_src_models_component_reference_.html">"src/models/component-reference"</a> | ||
</li> | ||
<li> | ||
<a href="_src_models_component_reference_.componentreference.html">ComponentReference</a> | ||
</li> | ||
</ul> | ||
<h1>Class ComponentReference</h1> | ||
</div> | ||
</div> | ||
</header> | ||
<div class="container container-main"> | ||
<div class="row"> | ||
<div class="col-8 col-content"> | ||
<section class="tsd-panel tsd-comment"> | ||
<div class="tsd-comment tsd-typography"> | ||
<div class="lead"> | ||
<p>表示一个组件的引用,被引用组件可能在当前文件,也可能在外部文件。例如:</p> | ||
</div> | ||
<p>// ComponentReference { specifier: './b.san', id: 'default' } | ||
import AComponent from './b.san'</p> | ||
<p>// ComponentReference { specifier: './b.san', id: 'AComponent' } | ||
import { AComponent } from './b.san'</p> | ||
</div> | ||
</section> | ||
<section class="tsd-panel tsd-hierarchy"> | ||
<h3>Hierarchy</h3> | ||
<ul class="tsd-hierarchy"> | ||
<li> | ||
<span class="target">ComponentReference</span> | ||
<ul class="tsd-hierarchy"> | ||
<li> | ||
<a href="_src_models_component_reference_.dynamiccomponentreference.html" class="tsd-signature-type">DynamicComponentReference</a> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</section> | ||
<section class="tsd-panel-group tsd-index-group"> | ||
<h2>Index</h2> | ||
<section class="tsd-panel tsd-index-panel"> | ||
<div class="tsd-index-content"> | ||
<section class="tsd-index-section "> | ||
<h3>Constructors</h3> | ||
<ul class="tsd-index-list"> | ||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_src_models_component_reference_.componentreference.html#constructor" class="tsd-kind-icon">constructor</a></li> | ||
</ul> | ||
</section> | ||
<section class="tsd-index-section "> | ||
<h3>Properties</h3> | ||
<ul class="tsd-index-list"> | ||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_models_component_reference_.componentreference.html#id" class="tsd-kind-icon">id</a></li> | ||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_models_component_reference_.componentreference.html#specifier" class="tsd-kind-icon">specifier</a></li> | ||
</ul> | ||
</section> | ||
<section class="tsd-index-section "> | ||
<h3>Methods</h3> | ||
<ul class="tsd-index-list"> | ||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_models_component_reference_.componentreference.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> | ||
</ul> | ||
</section> | ||
</div> | ||
</section> | ||
</section> | ||
<section class="tsd-panel-group tsd-member-group "> | ||
<h2>Constructors</h2> | ||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> | ||
<a name="constructor" class="tsd-anchor"></a> | ||
<h3>constructor</h3> | ||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> | ||
<li class="tsd-signature tsd-kind-icon">new <wbr>Component<wbr>Reference<span class="tsd-signature-symbol">(</span>specifier<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_models_component_reference_.componentreference.html" class="tsd-signature-type">ComponentReference</a></li> | ||
</ul> | ||
<ul class="tsd-descriptions"> | ||
<li class="tsd-description"> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/baidu/san-ssr/blob/17e19d2/src/models/component-reference.ts#L12">src/models/component-reference.ts:12</a></li> | ||
</ul> | ||
</aside> | ||
<h4 class="tsd-parameters-title">Parameters</h4> | ||
<ul class="tsd-parameters"> | ||
<li> | ||
<h5>specifier: <span class="tsd-signature-type">string</span></h5> | ||
</li> | ||
<li> | ||
<h5>id: <span class="tsd-signature-type">string</span></h5> | ||
</li> | ||
</ul> | ||
<h4 class="tsd-returns-title">Returns <a href="_src_models_component_reference_.componentreference.html" class="tsd-signature-type">ComponentReference</a></h4> | ||
</li> | ||
</ul> | ||
</section> | ||
</section> | ||
<section class="tsd-panel-group tsd-member-group "> | ||
<h2>Properties</h2> | ||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> | ||
<a name="id" class="tsd-anchor"></a> | ||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3> | ||
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/baidu/san-ssr/blob/17e19d2/src/models/component-reference.ts#L25">src/models/component-reference.ts:25</a></li> | ||
</ul> | ||
</aside> | ||
<div class="tsd-comment tsd-typography"> | ||
<div class="lead"> | ||
<p>组件在所属 SanSourceFile 中的唯一标识,用来文件间引用组件。</p> | ||
</div> | ||
<ul> | ||
<li>默认导出为的 ID 为 default,包括 module.exports = Component, export default Component</li> | ||
<li>其他导出的 ID 为 class 名,对于 ComponentClass(没有 Class 名)为递增数字</li> | ||
<li>ID 是语言无关的。不可直接用于目标语言文件中的标识符,后者需要解决名字冲突和标识符合法性的问题,是语言相关的。</li> | ||
</ul> | ||
</div> | ||
</section> | ||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> | ||
<a name="specifier" class="tsd-anchor"></a> | ||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> specifier</h3> | ||
<div class="tsd-signature tsd-kind-icon">specifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/baidu/san-ssr/blob/17e19d2/src/models/component-reference.ts#L17">src/models/component-reference.ts:17</a></li> | ||
</ul> | ||
</aside> | ||
<div class="tsd-comment tsd-typography"> | ||
<div class="lead"> | ||
<p>组件所在源文件的相对路径</p> | ||
</div> | ||
</div> | ||
</section> | ||
</section> | ||
<section class="tsd-panel-group tsd-member-group "> | ||
<h2>Methods</h2> | ||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> | ||
<a name="tostring" class="tsd-anchor"></a> | ||
<h3>to<wbr>String</h3> | ||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> | ||
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> | ||
</ul> | ||
<ul class="tsd-descriptions"> | ||
<li class="tsd-description"> | ||
<aside class="tsd-sources"> | ||
<ul> | ||
<li>Defined in <a href="https://github.com/baidu/san-ssr/blob/17e19d2/src/models/component-reference.ts#L28">src/models/component-reference.ts:28</a></li> | ||
</ul> | ||
</aside> | ||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> | ||
</li> | ||
</ul> | ||
</section> | ||
</section> | ||
</div> | ||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight"> | ||
<nav class="tsd-navigation primary"> | ||
<ul> | ||
<li class="globals "> | ||
<a href="../globals.html"><em>Globals</em></a> | ||
</li> | ||
<li class="current tsd-kind-module"> | ||
<a href="../modules/_src_models_component_reference_.html">"src/models/component-<wbr>reference"</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
<nav class="tsd-navigation secondary menu-sticky"> | ||
<ul class="before-current"> | ||
</ul> | ||
<ul class="current"> | ||
<li class="current tsd-kind-class tsd-parent-kind-module"> | ||
<a href="_src_models_component_reference_.componentreference.html" class="tsd-kind-icon">Component<wbr>Reference</a> | ||
<ul> | ||
<li class=" tsd-kind-constructor tsd-parent-kind-class"> | ||
<a href="_src_models_component_reference_.componentreference.html#constructor" class="tsd-kind-icon">constructor</a> | ||
</li> | ||
<li class=" tsd-kind-property tsd-parent-kind-class"> | ||
<a href="_src_models_component_reference_.componentreference.html#id" class="tsd-kind-icon">id</a> | ||
</li> | ||
<li class=" tsd-kind-property tsd-parent-kind-class"> | ||
<a href="_src_models_component_reference_.componentreference.html#specifier" class="tsd-kind-icon">specifier</a> | ||
</li> | ||
<li class=" tsd-kind-method tsd-parent-kind-class"> | ||
<a href="_src_models_component_reference_.componentreference.html#tostring" class="tsd-kind-icon">to<wbr>String</a> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
<ul class="after-current"> | ||
<li class=" tsd-kind-class tsd-parent-kind-module"> | ||
<a href="_src_models_component_reference_.dynamiccomponentreference.html" class="tsd-kind-icon">Dynamic<wbr>Component<wbr>Reference</a> | ||
</li> | ||
<li class=" tsd-kind-function tsd-parent-kind-module"> | ||
<a href="../modules/_src_models_component_reference_.html#componentid" class="tsd-kind-icon">componentID</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
</div> | ||
</div> | ||
</div> | ||
<footer class="with-border-bottom"> | ||
<div class="container"> | ||
<h2>Legend</h2> | ||
<div class="tsd-legend-group"> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> | ||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> | ||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> | ||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> | ||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> | ||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> | ||
</ul> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> | ||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> | ||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> | ||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> | ||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> | ||
</ul> | ||
<ul class="tsd-legend"> | ||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> | ||
</ul> | ||
</div> | ||
</div> | ||
</footer> | ||
<div class="container tsd-generator"> | ||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> | ||
</div> | ||
<div class="overlay"></div> | ||
<script src="../assets/js/main.js"></script> | ||
</body> | ||
</html> |
Oops, something went wrong.