Skip to content

Commit 8519ecd

Browse files
doc(elements): rebuild readme
1 parent 13ecf50 commit 8519ecd

7 files changed

Lines changed: 61 additions & 20 deletions

File tree

docs/elements/components/pos-add-literal-value/readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
## Events
99

10-
| Event | Description | Type |
11-
| ---------------------------- | -------------------------------------------------------------------------------------------- | ------------------ |
12-
| `pod-os:added-literal-value` | The entered literal value has been added to the resource and successfully stored to the Pod. | `CustomEvent<any>` |
13-
| `pod-os:error` | Something went wrong while adding the literal value. | `CustomEvent<any>` |
14-
| `pod-os:init` | | `CustomEvent<any>` |
15-
| `pod-os:resource` | | `CustomEvent<any>` |
10+
| Event | Description | Type |
11+
| ---------------------------- | -------------------------------------------------------------------------------------------- | ---------------------- |
12+
| `pod-os:added-literal-value` | The entered literal value has been added to the resource and successfully stored to the Pod. | `CustomEvent<Literal>` |
13+
| `pod-os:error` | Something went wrong while adding the literal value. | `CustomEvent<any>` |
14+
| `pod-os:init` | | `CustomEvent<any>` |
15+
| `pod-os:resource` | | `CustomEvent<any>` |
1616

1717

1818
## Dependencies

docs/elements/components/pos-add-relation/readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77

88
Add a new relation from the current resource to another one
99

10+
## Events
11+
12+
| Event | Description | Type |
13+
| ----------------------- | ------------------------------------------------------------------------------- | ----------------------- |
14+
| `pod-os:added-relation` | The relation has been added to the resource and successfully stored to the Pod. | `CustomEvent<Relation>` |
15+
| `pod-os:error` | Something went wrong while adding the relation. | `CustomEvent<any>` |
16+
17+
1018
## Dependencies
1119

1220
### Used by

docs/elements/components/pos-description/readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<!-- Auto Generated Below -->
66

77

8+
## Overview
9+
10+
Displays a description of the resource, as provided by [Thing.description()](https://pod-os.org/reference/core/classes/thing/#description).
11+
12+
Re-renders when data in the store changes using [Thing.observeDescription()](https://pod-os.org/reference/core/classes/thing/#observeDescription).
13+
814
## Events
915

1016
| Event | Description | Type |

docs/elements/components/pos-label/readme.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77

88
## Overview
99

10-
Displays a human-readable label of the resource, provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label)
10+
Displays a human-readable label of the resource, as provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label).
11+
12+
Re-renders when data in the store changes using [Thing.observeLabel()](https://pod-os.org/reference/core/classes/thing/#observeLabel).
1113

1214
## Events
1315

docs/elements/components/pos-select-term/readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515

1616
## Events
1717

18-
| Event | Description | Type |
19-
| ---------------------- | ---------------------------------------- | ------------------ |
20-
| `pod-os:init` | | `CustomEvent<any>` |
21-
| `pod-os:term-selected` | Fires when a term is entered or selected | `CustomEvent<any>` |
18+
| Event | Description | Type |
19+
| ---------------------- | ---------------------------------------- | ------------------------------- |
20+
| `pod-os:init` | | `CustomEvent<any>` |
21+
| `pod-os:term-selected` | Fires when a term is entered or selected | `CustomEvent<{ uri: string; }>` |
2222

2323

2424
## Shadow Parts

docs/elements/components/pos-value/readme.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
## Overview
99

1010
Shows a single value linked to the resource using the given predicate.
11-
The value is determined by [Thing.anyValue()](https://pod-os.org/reference/core/classes/thing/#anyvalue)
11+
The value is determined by [Thing.observeAnyValue()](https://pod-os.org/reference/core/classes/thing/#observeanyvalue)
12+
and re-renders when data in the store changes
1213

1314
## Properties
1415

elements/src/components.d.ts

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ export namespace Components {
9999
"container": LdpContainer;
100100
"type": 'file' | 'folder';
101101
}
102+
/**
103+
* Displays a description of the resource, as provided by [Thing.description()](https://pod-os.org/reference/core/classes/thing/#description).
104+
* Re-renders when data in the store changes using [Thing.observeDescription()](https://pod-os.org/reference/core/classes/thing/#observeDescription).
105+
*/
102106
interface PosDescription {
103107
}
104108
/**
@@ -139,7 +143,8 @@ export namespace Components {
139143
"uri": string;
140144
}
141145
/**
142-
* Displays a human-readable label of the resource, provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label)
146+
* Displays a human-readable label of the resource, as provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label).
147+
* Re-renders when data in the store changes using [Thing.observeLabel()](https://pod-os.org/reference/core/classes/thing/#observeLabel).
143148
*/
144149
interface PosLabel {
145150
}
@@ -360,7 +365,8 @@ export namespace Components {
360365
}
361366
/**
362367
* Shows a single value linked to the resource using the given predicate.
363-
* The value is determined by [Thing.anyValue()](https://pod-os.org/reference/core/classes/thing/#anyvalue)
368+
* The value is determined by [Thing.observeAnyValue()](https://pod-os.org/reference/core/classes/thing/#observeanyvalue)
369+
* and re-renders when data in the store changes
364370
*/
365371
interface PosValue {
366372
/**
@@ -749,6 +755,10 @@ declare global {
749755
interface HTMLPosDescriptionElementEventMap {
750756
"pod-os:resource": any;
751757
}
758+
/**
759+
* Displays a description of the resource, as provided by [Thing.description()](https://pod-os.org/reference/core/classes/thing/#description).
760+
* Re-renders when data in the store changes using [Thing.observeDescription()](https://pod-os.org/reference/core/classes/thing/#observeDescription).
761+
*/
752762
interface HTMLPosDescriptionElement extends Components.PosDescription, HTMLStencilElement {
753763
addEventListener<K extends keyof HTMLPosDescriptionElementEventMap>(type: K, listener: (this: HTMLPosDescriptionElement, ev: PosDescriptionCustomEvent<HTMLPosDescriptionElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
754764
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -853,7 +863,8 @@ declare global {
853863
"pod-os:resource": any;
854864
}
855865
/**
856-
* Displays a human-readable label of the resource, provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label)
866+
* Displays a human-readable label of the resource, as provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label).
867+
* Re-renders when data in the store changes using [Thing.observeLabel()](https://pod-os.org/reference/core/classes/thing/#observeLabel).
857868
*/
858869
interface HTMLPosLabelElement extends Components.PosLabel, HTMLStencilElement {
859870
addEventListener<K extends keyof HTMLPosLabelElementEventMap>(type: K, listener: (this: HTMLPosLabelElement, ev: PosLabelCustomEvent<HTMLPosLabelElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1341,7 +1352,8 @@ declare global {
13411352
}
13421353
/**
13431354
* Shows a single value linked to the resource using the given predicate.
1344-
* The value is determined by [Thing.anyValue()](https://pod-os.org/reference/core/classes/thing/#anyvalue)
1355+
* The value is determined by [Thing.observeAnyValue()](https://pod-os.org/reference/core/classes/thing/#observeanyvalue)
1356+
* and re-renders when data in the store changes
13451357
*/
13461358
interface HTMLPosValueElement extends Components.PosValue, HTMLStencilElement {
13471359
addEventListener<K extends keyof HTMLPosValueElementEventMap>(type: K, listener: (this: HTMLPosValueElement, ev: PosValueCustomEvent<HTMLPosValueElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1539,6 +1551,10 @@ declare namespace LocalJSX {
15391551
"onPod-os:link"?: (event: PosCreateNewContainerItemCustomEvent<string>) => void;
15401552
"type": 'file' | 'folder';
15411553
}
1554+
/**
1555+
* Displays a description of the resource, as provided by [Thing.description()](https://pod-os.org/reference/core/classes/thing/#description).
1556+
* Re-renders when data in the store changes using [Thing.observeDescription()](https://pod-os.org/reference/core/classes/thing/#observeDescription).
1557+
*/
15421558
interface PosDescription {
15431559
"onPod-os:resource"?: (event: PosDescriptionCustomEvent<any>) => void;
15441560
}
@@ -1593,7 +1609,8 @@ declare namespace LocalJSX {
15931609
"uri"?: string;
15941610
}
15951611
/**
1596-
* Displays a human-readable label of the resource, provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label)
1612+
* Displays a human-readable label of the resource, as provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label).
1613+
* Re-renders when data in the store changes using [Thing.observeLabel()](https://pod-os.org/reference/core/classes/thing/#observeLabel).
15971614
*/
15981615
interface PosLabel {
15991616
"onPod-os:resource"?: (event: PosLabelCustomEvent<any>) => void;
@@ -1855,7 +1872,8 @@ declare namespace LocalJSX {
18551872
}
18561873
/**
18571874
* Shows a single value linked to the resource using the given predicate.
1858-
* The value is determined by [Thing.anyValue()](https://pod-os.org/reference/core/classes/thing/#anyvalue)
1875+
* The value is determined by [Thing.observeAnyValue()](https://pod-os.org/reference/core/classes/thing/#observeanyvalue)
1876+
* and re-renders when data in the store changes
18591877
*/
18601878
interface PosValue {
18611879
"onPod-os:resource"?: (event: PosValueCustomEvent<any>) => void;
@@ -2046,6 +2064,10 @@ declare module "@stencil/core" {
20462064
"pos-container-item": LocalJSX.IntrinsicElements["pos-container-item"] & JSXBase.HTMLAttributes<HTMLPosContainerItemElement>;
20472065
"pos-container-toolbar": LocalJSX.IntrinsicElements["pos-container-toolbar"] & JSXBase.HTMLAttributes<HTMLPosContainerToolbarElement>;
20482066
"pos-create-new-container-item": LocalJSX.IntrinsicElements["pos-create-new-container-item"] & JSXBase.HTMLAttributes<HTMLPosCreateNewContainerItemElement>;
2067+
/**
2068+
* Displays a description of the resource, as provided by [Thing.description()](https://pod-os.org/reference/core/classes/thing/#description).
2069+
* Re-renders when data in the store changes using [Thing.observeDescription()](https://pod-os.org/reference/core/classes/thing/#observeDescription).
2070+
*/
20492071
"pos-description": LocalJSX.IntrinsicElements["pos-description"] & JSXBase.HTMLAttributes<HTMLPosDescriptionElement>;
20502072
/**
20512073
* Styled wrapper around native dialog element, with slots `title` and `content`
@@ -2063,7 +2085,8 @@ declare module "@stencil/core" {
20632085
"pos-image": LocalJSX.IntrinsicElements["pos-image"] & JSXBase.HTMLAttributes<HTMLPosImageElement>;
20642086
"pos-internal-router": LocalJSX.IntrinsicElements["pos-internal-router"] & JSXBase.HTMLAttributes<HTMLPosInternalRouterElement>;
20652087
/**
2066-
* Displays a human-readable label of the resource, provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label)
2088+
* Displays a human-readable label of the resource, as provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label).
2089+
* Re-renders when data in the store changes using [Thing.observeLabel()](https://pod-os.org/reference/core/classes/thing/#observeLabel).
20672090
*/
20682091
"pos-label": LocalJSX.IntrinsicElements["pos-label"] & JSXBase.HTMLAttributes<HTMLPosLabelElement>;
20692092
/**
@@ -2141,7 +2164,8 @@ declare module "@stencil/core" {
21412164
"pos-user-menu": LocalJSX.IntrinsicElements["pos-user-menu"] & JSXBase.HTMLAttributes<HTMLPosUserMenuElement>;
21422165
/**
21432166
* Shows a single value linked to the resource using the given predicate.
2144-
* The value is determined by [Thing.anyValue()](https://pod-os.org/reference/core/classes/thing/#anyvalue)
2167+
* The value is determined by [Thing.observeAnyValue()](https://pod-os.org/reference/core/classes/thing/#observeanyvalue)
2168+
* and re-renders when data in the store changes
21452169
*/
21462170
"pos-value": LocalJSX.IntrinsicElements["pos-value"] & JSXBase.HTMLAttributes<HTMLPosValueElement>;
21472171
}

0 commit comments

Comments
 (0)