@pod-os/elements 0.38.0 → 0.39.0-rc.dc9b993.0

package/dist/collection/components/pos-list/pos-list.js

@@ -2,6 +2,14 @@ import { h } from "@stencil/core";
 import { subscribeResource } from "../events/ResourceAware";
 import { subscribePodOs } from "../events/PodOsAware";
 import { Subject, takeUntil } from "rxjs";
+/**
+ * Renders a template for each resource in a list. The list is either defined by a relation from the parent resource
+ * or by a class for which instances will be listed.
+ *
+ * `pos-list` must contain a `<template>` as a single child component. This template will be used to render each resource
+ * in the list. All PodOS elements within this template will receive the listed resource as their context, e.g. a `pos-label`
+ * will then render the label of each list item.
+ */
 export class PosList {
     constructor() {
         /**

package/dist/types/components/pos-list/pos-list.d.ts

@@ -1,6 +1,14 @@
 import { PodOS, Thing } from '@pod-os/core';
 import { ResourceAware, ResourceEventEmitter } from '../events/ResourceAware';
 import { PodOsAware, PodOsEventEmitter } from '../events/PodOsAware';
+/**
+ * Renders a template for each resource in a list. The list is either defined by a relation from the parent resource
+ * or by a class for which instances will be listed.
+ *
+ * `pos-list` must contain a `<template>` as a single child component. This template will be used to render each resource
+ * in the list. All PodOS elements within this template will receive the listed resource as their context, e.g. a `pos-label`
+ * will then render the label of each list item.
+ */
 export declare class PosList implements PodOsAware, ResourceAware {
     /**
      * URI of the predicate to follow

package/dist/types/components.d.ts

@@ -138,6 +138,13 @@ export namespace Components {
      */
     interface PosLabel {
     }
+    /**
+     * Renders a template for each resource in a list. The list is either defined by a relation from the parent resource
+     * or by a class for which instances will be listed.
+     * `pos-list` must contain a `<template>` as a single child component. This template will be used to render each resource
+     * in the list. All PodOS elements within this template will receive the listed resource as their context, e.g. a `pos-label`
+     * will then render the label of each list item.
+     */
     interface PosList {
         /**
           * Whether listed resources should be fetched before being displayed
@@ -825,6 +832,13 @@ declare global {
         "pod-os:resource": any;
         "pod-os:init": any;
     }
+    /**
+     * Renders a template for each resource in a list. The list is either defined by a relation from the parent resource
+     * or by a class for which instances will be listed.
+     * `pos-list` must contain a `<template>` as a single child component. This template will be used to render each resource
+     * in the list. All PodOS elements within this template will receive the listed resource as their context, e.g. a `pos-label`
+     * will then render the label of each list item.
+     */
     interface HTMLPosListElement extends Components.PosList, HTMLStencilElement {
         addEventListener<K extends keyof HTMLPosListElementEventMap>(type: K, listener: (this: HTMLPosListElement, ev: PosListCustomEvent<HTMLPosListElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
         addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1518,6 +1532,13 @@ declare namespace LocalJSX {
     interface PosLabel {
         "onPod-os:resource"?: (event: PosLabelCustomEvent<any>) => void;
     }
+    /**
+     * Renders a template for each resource in a list. The list is either defined by a relation from the parent resource
+     * or by a class for which instances will be listed.
+     * `pos-list` must contain a `<template>` as a single child component. This template will be used to render each resource
+     * in the list. All PodOS elements within this template will receive the listed resource as their context, e.g. a `pos-label`
+     * will then render the label of each list item.
+     */
     interface PosList {
         /**
           * Whether listed resources should be fetched before being displayed
@@ -1963,6 +1984,13 @@ declare module "@stencil/core" {
              * Displays a human-readable label of the resource, provided by [Thing.label()](https://pod-os.org/reference/core/classes/thing/#label)
              */
             "pos-label": LocalJSX.IntrinsicElements["pos-label"] & JSXBase.HTMLAttributes<HTMLPosLabelElement>;
+            /**
+             * Renders a template for each resource in a list. The list is either defined by a relation from the parent resource
+             * or by a class for which instances will be listed.
+             * `pos-list` must contain a `<template>` as a single child component. This template will be used to render each resource
+             * in the list. All PodOS elements within this template will receive the listed resource as their context, e.g. a `pos-label`
+             * will then render the label of each list item.
+             */
             "pos-list": LocalJSX.IntrinsicElements["pos-list"] & JSXBase.HTMLAttributes<HTMLPosListElement>;
             "pos-literals": LocalJSX.IntrinsicElements["pos-literals"] & JSXBase.HTMLAttributes<HTMLPosLiteralsElement>;
             "pos-login": LocalJSX.IntrinsicElements["pos-login"] & JSXBase.HTMLAttributes<HTMLPosLoginElement>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pod-os/elements",
-  "version": "0.38.0",
+  "version": "0.39.0-rc.dc9b993.0",
   "description": "Custom elements for usage with Solid Pods",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
@@ -21,7 +21,7 @@
     "generate": "stencil generate"
   },
   "dependencies": {
-    "@pod-os/core": "^0.27.0",
+    "@pod-os/core": "v0.28.0-rc.dc9b993.0",
     "@shoelace-style/shoelace": "^2.20.1",
     "@stencil/core": "^4.43.2",
     "@stencil/store": "^2.2.2",