Skip to content

Commit d7df302

Browse files
doc(elements): pos-list update
1 parent 0584cfc commit d7df302

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@
44

55
## Properties
66

7-
| Property | Attribute | Description | Type | Default |
8-
| -------- | --------- | ----------------------------------------------------------------- | --------- | ----------- |
9-
| `fetch` | `fetch` | Whether listed resources should be fetched before being displayed | `boolean` | `false` |
10-
| `rel` | `rel` | URI of the predicate to follow | `string` | `undefined` |
7+
| Property | Attribute | Description | Type | Default |
8+
| ---------- | ----------- | ----------------------------------------------------------------- | --------- | ----------- |
9+
| `fetch` | `fetch` | Whether listed resources should be fetched before being displayed | `boolean` | `false` |
10+
| `ifTypeof` | `if-typeof` | URI of a class for which instances will be listed | `string` | `undefined` |
11+
| `rel` | `rel` | URI of the predicate to follow | `string` | `undefined` |
1112

1213

1314
## Events
1415

1516
| Event | Description | Type |
1617
| ----------------- | ----------- | ------------------ |
18+
| `pod-os:init` | | `CustomEvent<any>` |
1719
| `pod-os:resource` | | `CustomEvent<any>` |
1820

1921

elements/src/components.d.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ export namespace Components {
8383
* Whether listed resources should be fetched before being displayed
8484
*/
8585
"fetch": boolean;
86+
/**
87+
* URI of a class for which instances will be listed
88+
*/
89+
"ifTypeof": string;
8690
/**
8791
* URI of the predicate to follow
8892
*/
@@ -574,6 +578,7 @@ declare global {
574578
};
575579
interface HTMLPosListElementEventMap {
576580
"pod-os:resource": any;
581+
"pod-os:init": any;
577582
}
578583
interface HTMLPosListElement extends Components.PosList, HTMLStencilElement {
579584
addEventListener<K extends keyof HTMLPosListElementEventMap>(type: K, listener: (this: HTMLPosListElement, ev: PosListCustomEvent<HTMLPosListElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1100,6 +1105,11 @@ declare namespace LocalJSX {
11001105
* Whether listed resources should be fetched before being displayed
11011106
*/
11021107
"fetch"?: boolean;
1108+
/**
1109+
* URI of a class for which instances will be listed
1110+
*/
1111+
"ifTypeof"?: string;
1112+
"onPod-os:init"?: (event: PosListCustomEvent<any>) => void;
11031113
"onPod-os:resource"?: (event: PosListCustomEvent<any>) => void;
11041114
/**
11051115
* URI of the predicate to follow

0 commit comments

Comments
 (0)