Skip to content

Commit ca564f2

Browse files
committed
angular/vue/react doc updates
* make sure to refer to common doc instead of dup 3x content
1 parent aff6b73 commit ca564f2

16 files changed

Lines changed: 201 additions & 334 deletions

angular/doc/api/gridstack-item.component.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ return the latest grid options (from GS once built, otherwise initial values)
4646

4747
###### Returns
4848

49-
`GridStackNode`
49+
[`GridStackNode`](../../../doc/API.md#gridstacknode)
5050

5151
###### Set Signature
5252

@@ -73,7 +73,7 @@ itemOptions: GridStackNode = {
7373

7474
| Parameter | Type |
7575
| ------ | ------ |
76-
| `val` | `GridStackNode` |
76+
| `val` | [`GridStackNode`](../../../doc/API.md#gridstacknode) |
7777

7878
###### Returns
7979

@@ -159,7 +159,7 @@ OnDestroy.ngOnDestroy
159159
| <a id="container"></a> `container?` | `public` | `ViewContainerRef` | Container for dynamic component creation within this grid item. Used to append child components programmatically. | [angular/projects/lib/src/lib/gridstack-item.component.ts:62](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L62) |
160160
| <a id="ref"></a> `ref` | `public` | \| `undefined` \| `ComponentRef`\<[`GridstackItemComponent`](#gridstackitemcomponent)\> | Component reference for dynamic component removal. Used internally when this component is created dynamically. | [angular/projects/lib/src/lib/gridstack-item.component.ts:68](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L68) |
161161
| <a id="childwidget"></a> `childWidget` | `public` | `undefined` \| [`BaseWidget`](base-widget.md#basewidget) | Reference to child widget component for serialization. Used to save/restore additional data along with grid position. | [angular/projects/lib/src/lib/gridstack-item.component.ts:74](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L74) |
162-
| <a id="_options"></a> `_options?` | `protected` | `GridStackNode` | - | [angular/projects/lib/src/lib/gridstack-item.component.ts:104](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L104) |
162+
| <a id="_options"></a> `_options?` | `protected` | [`GridStackNode`](../../../doc/API.md#gridstacknode) | - | [angular/projects/lib/src/lib/gridstack-item.component.ts:104](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L104) |
163163
| <a id="elementref"></a> `elementRef` | `readonly` | `ElementRef`\<[`GridItemCompHTMLElement`](#griditemcomphtmlelement)\> | - | [angular/projects/lib/src/lib/gridstack-item.component.ts:114](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L114) |
164164

165165
## Interfaces
@@ -173,7 +173,7 @@ Stores a back-reference to the Angular component for integration.
173173

174174
#### Extends
175175

176-
- `GridItemHTMLElement`
176+
- [`GridItemHTMLElement`](../../../doc/API.md#griditemhtmlelement)
177177

178178
#### Methods
179179

@@ -2671,7 +2671,6 @@ GridItemHTMLElement.replaceChildren
26712671
26722672
| Property | Modifier | Type | Description | Inherited from | Defined in |
26732673
| ------ | ------ | ------ | ------ | ------ | ------ |
2674-
| <a id="gridstacknode"></a> `gridstackNode?` | `public` | `GridStackNode` | Pointer to the associated grid node instance containing position, size, and other widget data | `GridItemHTMLElement.gridstackNode` | dist/types.d.ts:45 |
26752674
| <a id="_griditemcomp"></a> `_gridItemComp?` | `public` | [`GridstackItemComponent`](#gridstackitemcomponent) | Back-reference to the Angular GridStackItem component | - | [angular/projects/lib/src/lib/gridstack-item.component.ts:16](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L16) |
26762675
| <a id="ariaatomic"></a> `ariaAtomic` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaAtomic` | node\_modules/typescript/lib/lib.dom.d.ts:2020 |
26772676
| <a id="ariaautocomplete"></a> `ariaAutoComplete` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaAutoComplete` | node\_modules/typescript/lib/lib.dom.d.ts:2021 |

angular/doc/api/gridstack.component.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Get the current running grid options
4646

4747
###### Returns
4848

49-
`GridStackOptions`
49+
[`GridStackOptions`](../../../doc/API.md#gridstackoptions)
5050

5151
###### Set Signature
5252

@@ -73,7 +73,7 @@ gridOptions: GridStackOptions = {
7373

7474
| Parameter | Type |
7575
| ------ | ------ |
76-
| `o` | `GridStackOptions` |
76+
| `o` | [`GridStackOptions`](../../../doc/API.md#gridstackoptions) |
7777

7878
###### Returns
7979

@@ -344,7 +344,7 @@ Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:338](https://gi
344344
| <a id="resizestopcb"></a> `resizeStopCB` | `public` | `EventEmitter`\<[`elementCB`](#elementcb)\> | `undefined` | Emitted when widget resize stops | [angular/projects/lib/src/lib/gridstack.component.ts:185](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L185) |
345345
| <a id="ref"></a> `ref` | `public` | \| `undefined` \| `ComponentRef`\<[`GridstackComponent`](#gridstackcomponent)\> | `undefined` | Component reference for dynamic component removal. Used internally when this component is created dynamically. | [angular/projects/lib/src/lib/gridstack.component.ts:208](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L208) |
346346
| <a id="componentmap-1"></a> `componentMap` | `static` | [`ComponentMap`](#componentmap) | `{}` | Map of component keys to Angular component types used for dynamic creation. Keys default to the component's `@Component.selector` string when registered via `registerComponents()`. | [angular/projects/lib/src/lib/gridstack.component.ts:215](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L215) |
347-
| <a id="_options"></a> `_options?` | `protected` | `GridStackOptions` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:243](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L243) |
347+
| <a id="_options"></a> `_options?` | `protected` | [`GridStackOptions`](../../../doc/API.md#gridstackoptions) | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:243](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L243) |
348348
| <a id="_grid"></a> `_grid?` | `protected` | `GridStack` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:244](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L244) |
349349
| <a id="_sub"></a> `_sub` | `protected` | `undefined` \| `Subscription` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:245](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L245) |
350350
| <a id="loaded"></a> `loaded?` | `protected` | `boolean` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:246](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L246) |
@@ -361,7 +361,7 @@ Stores a back-reference to the Angular component for integration purposes.
361361
362362
#### Extends
363363
364-
- `GridHTMLElement`
364+
- [`GridHTMLElement`](../../../doc/API.md#gridhtmlelement)
365365
366366
#### Methods
367367
@@ -2859,7 +2859,6 @@ GridHTMLElement.replaceChildren
28592859
28602860
| Property | Modifier | Type | Description | Inherited from | Defined in |
28612861
| ------ | ------ | ------ | ------ | ------ | ------ |
2862-
| <a id="gridstack"></a> `gridstack?` | `public` | `GridStack` | - | `GridHTMLElement.gridstack` | dist/gridstack.d.ts:24 |
28632862
| <a id="_gridcomp"></a> `_gridComp?` | `public` | [`GridstackComponent`](#gridstackcomponent) | Back-reference to the Angular GridStack component | - | [angular/projects/lib/src/lib/gridstack.component.ts:41](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L41) |
28642863
| <a id="ariaatomic"></a> `ariaAtomic` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaAtomic` | node\_modules/typescript/lib/lib.dom.d.ts:2020 |
28652864
| <a id="ariaautocomplete"></a> `ariaAutoComplete` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaAutoComplete` | node\_modules/typescript/lib/lib.dom.d.ts:2021 |

0 commit comments

Comments
 (0)