@devtools-ui/list 0.4.0 → 0.4.1-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -0
- package/dist/cjs/index.cjs +3 -3
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.legacy-esm.js +4 -1
- package/dist/index.mjs +4 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +13 -13
- package/src/dsl/List.tsx +5 -1
- package/src/dsl/__tests__/List.test.tsx +1 -1
- package/types/dsl/List.d.ts +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# @devtools-ui/list
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
`@devtools-ui/list` is a component package designed to be leveraged by a [Player-UI assets plugin](https://player-ui.github.io/next/plugins).
|
|
6
|
+
|
|
7
|
+
It provides a `List` component that can be used group assets into an ordered or unordered list.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
To install `@devtools-ui/list`, you can use pnpm or yarn:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
pnpm i @devtools-ui/list
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
or
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
yarn add @devtools-ui/list
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
You can leverage this asset through the `@devtools-ui/plugin`:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import { List } from "@devtools-ui/plugin";
|
|
29
|
+
|
|
30
|
+
// and use it to define your Player-UI content:
|
|
31
|
+
myFlow = {
|
|
32
|
+
id: "my_flow",
|
|
33
|
+
views: [
|
|
34
|
+
<MyView>
|
|
35
|
+
<List metaData={{ ordered: true }}>
|
|
36
|
+
<List.Values>
|
|
37
|
+
<Asset type="text">
|
|
38
|
+
<property name="value">Test 1</property>
|
|
39
|
+
</Asset>
|
|
40
|
+
<Asset type="text">
|
|
41
|
+
<property name="value">Test 2</property>
|
|
42
|
+
</Asset>
|
|
43
|
+
</List.Values>
|
|
44
|
+
</List>
|
|
45
|
+
</MyView>,
|
|
46
|
+
],
|
|
47
|
+
};
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
For more information on how to author Player-UI content using DSL, please check our [Player-UI docs](https://player-ui.github.io/next/dsl#tsxjsx-content-authoring-player-dsl).
|
|
51
|
+
|
|
52
|
+
Or, your can leverage this asset in your own plugin:
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
// AssetRegistryPlugin.ts
|
|
56
|
+
import React from "react";
|
|
57
|
+
import type { Player } from "@player-ui/player";
|
|
58
|
+
import type {
|
|
59
|
+
ExtendedPlayerPlugin,
|
|
60
|
+
ReactPlayer,
|
|
61
|
+
ReactPlayerPlugin,
|
|
62
|
+
} from "@player-ui/react";
|
|
63
|
+
import { AssetProviderPlugin } from "@player-ui/asset-provider-plugin-react";
|
|
64
|
+
import { TransformsPlugin } from "./TransformPlugin";
|
|
65
|
+
import { ListAsset, ListComponent } from "@devtools-ui/list";
|
|
66
|
+
|
|
67
|
+
export class AssetsRegistryPlugin
|
|
68
|
+
implements ReactPlayerPlugin, ExtendedPlayerPlugin<[ListAsset]>
|
|
69
|
+
{
|
|
70
|
+
name = "my-plugin";
|
|
71
|
+
|
|
72
|
+
applyReact(reactPlayer: ReactPlayer) {
|
|
73
|
+
reactPlayer.registerPlugin(
|
|
74
|
+
new AssetProviderPlugin([["list", ListComponent]])
|
|
75
|
+
);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
apply(player: Player) {
|
|
79
|
+
player.registerPlugin(new TransformsPlugin());
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Contributing
|
|
85
|
+
|
|
86
|
+
We welcome contributions to `@devtools-ui/list`!
|
package/dist/cjs/index.cjs
CHANGED
|
@@ -45,14 +45,14 @@ var ListComponent = (props) => {
|
|
|
45
45
|
|
|
46
46
|
// ../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/dsl/List.tsx
|
|
47
47
|
var import_react4 = __toESM(require("react"));
|
|
48
|
-
var
|
|
48
|
+
var import_react_dsl = require("@player-lang/react-dsl");
|
|
49
49
|
var import_text = require("@devtools-ui/text");
|
|
50
50
|
var import_collection = require("@devtools-ui/collection");
|
|
51
|
-
var List = (props) => /* @__PURE__ */ import_react4.default.createElement(
|
|
51
|
+
var List = (props) => /* @__PURE__ */ import_react4.default.createElement(import_react_dsl.Asset, { type: "list", ...props });
|
|
52
52
|
var CollectionComp = (props) => {
|
|
53
53
|
return /* @__PURE__ */ import_react4.default.createElement(import_collection.Collection, null, /* @__PURE__ */ import_react4.default.createElement(import_collection.Collection.Values, null, props.children));
|
|
54
54
|
};
|
|
55
|
-
List.Values = (0,
|
|
55
|
+
List.Values = (0, import_react_dsl.createSlot)({
|
|
56
56
|
name: "values",
|
|
57
57
|
TextComp: import_text.Text,
|
|
58
58
|
CollectionComp,
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/components/ListComponent.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/dsl/List.tsx"],"sourcesContent":["export * from \"./types\";\nexport * from \"./components\";\nexport * from \"./dsl\";\n","import React from \"react\";\nimport { ListItem, OrderedList, UnorderedList } from \"@chakra-ui/react\";\nimport { ListAsset } from \"../types\";\nimport { ReactAsset } from \"@player-ui/react\";\n\nexport const ListComponent = (props: ListAsset) => {\n return props.metaData?.ordered ? (\n <UnorderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </UnorderedList>\n ) : (\n <OrderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </OrderedList>\n );\n};\n","import React from \"react\";\nimport {
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/components/ListComponent.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/dsl/List.tsx"],"sourcesContent":["export * from \"./types\";\nexport * from \"./components\";\nexport * from \"./dsl\";\n","import React from \"react\";\nimport { ListItem, OrderedList, UnorderedList } from \"@chakra-ui/react\";\nimport { ListAsset } from \"../types\";\nimport { ReactAsset } from \"@player-ui/react\";\n\nexport const ListComponent = (props: ListAsset) => {\n return props.metaData?.ordered ? (\n <UnorderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </UnorderedList>\n ) : (\n <OrderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </OrderedList>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n} from \"@player-lang/react-dsl\";\nimport { Text } from \"@devtools-ui/text\";\nimport type { Asset as AssetType } from \"@player-ui/player\";\nimport { Collection } from \"@devtools-ui/collection\";\nimport { ListAsset } from \"../types\";\n\nexport const List = (props: AssetPropsWithChildren<ListAsset>) => (\n <Asset type={\"list\"} {...props}></Asset>\n);\n\nconst CollectionComp = (props: AssetPropsWithChildren<AssetType>) => {\n return (\n <Collection>\n <Collection.Values>{props.children}</Collection.Values>\n </Collection>\n );\n};\n\nList.Values = createSlot({\n name: \"values\",\n TextComp: Text,\n CollectionComp,\n isArray: true,\n wrapInAsset: true,\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAkB;AAClB,IAAAA,gBAAqD;AAErD,IAAAA,gBAA2B;AAEpB,IAAM,gBAAgB,CAAC,UAAqB;AACjD,SAAO,MAAM,UAAU,UACrB,6BAAAC,QAAA,cAAC,mCACE,MAAM,UACL,MAAM,OAAO,IAAI,CAAC,EAAE,MAAM,MACxB,6BAAAA,QAAA,cAAC,0BAAS,KAAK,MAAM,MACnB,6BAAAA,QAAA,cAAC,4BAAY,GAAG,OAAO,CACzB,CACD,CACL,IAEA,6BAAAA,QAAA,cAAC,iCACE,MAAM,UACL,MAAM,OAAO,IAAI,CAAC,EAAE,MAAM,MACxB,6BAAAA,QAAA,cAAC,0BAAS,KAAK,MAAM,MACnB,6BAAAA,QAAA,cAAC,4BAAY,GAAG,OAAO,CACzB,CACD,CACL;AAEJ;;;ACzBA,IAAAC,gBAAkB;AAClB,uBAIO;AACP,kBAAqB;AAErB,wBAA2B;AAGpB,IAAM,OAAO,CAAC,UACnB,8BAAAC,QAAA,cAAC,0BAAM,MAAM,QAAS,GAAG,OAAO;AAGlC,IAAM,iBAAiB,CAAC,UAA6C;AACnE,SACE,8BAAAA,QAAA,cAAC,oCACC,8BAAAA,QAAA,cAAC,6BAAW,QAAX,MAAmB,MAAM,QAAS,CACrC;AAEJ;AAEA,KAAK,aAAS,6BAAW;AAAA,EACvB,MAAM;AAAA,EACN,UAAU;AAAA,EACV;AAAA,EACA,SAAS;AAAA,EACT,aAAa;AACf,CAAC;","names":["import_react","React","import_react","React"]}
|
package/dist/index.legacy-esm.js
CHANGED
|
@@ -8,7 +8,10 @@ var ListComponent = (props) => {
|
|
|
8
8
|
|
|
9
9
|
// ../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/dsl/List.tsx
|
|
10
10
|
import React2 from "react";
|
|
11
|
-
import {
|
|
11
|
+
import {
|
|
12
|
+
Asset,
|
|
13
|
+
createSlot
|
|
14
|
+
} from "@player-lang/react-dsl";
|
|
12
15
|
import { Text } from "@devtools-ui/text";
|
|
13
16
|
import { Collection } from "@devtools-ui/collection";
|
|
14
17
|
var List = (props) => /* @__PURE__ */ React2.createElement(Asset, { type: "list", ...props });
|
package/dist/index.mjs
CHANGED
|
@@ -8,7 +8,10 @@ var ListComponent = (props) => {
|
|
|
8
8
|
|
|
9
9
|
// ../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/dsl/List.tsx
|
|
10
10
|
import React2 from "react";
|
|
11
|
-
import {
|
|
11
|
+
import {
|
|
12
|
+
Asset,
|
|
13
|
+
createSlot
|
|
14
|
+
} from "@player-lang/react-dsl";
|
|
12
15
|
import { Text } from "@devtools-ui/text";
|
|
13
16
|
import { Collection } from "@devtools-ui/collection";
|
|
14
17
|
var List = (props) => /* @__PURE__ */ React2.createElement(Asset, { type: "list", ...props });
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/components/ListComponent.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/dsl/List.tsx"],"sourcesContent":["import React from \"react\";\nimport { ListItem, OrderedList, UnorderedList } from \"@chakra-ui/react\";\nimport { ListAsset } from \"../types\";\nimport { ReactAsset } from \"@player-ui/react\";\n\nexport const ListComponent = (props: ListAsset) => {\n return props.metaData?.ordered ? (\n <UnorderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </UnorderedList>\n ) : (\n <OrderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </OrderedList>\n );\n};\n","import React from \"react\";\nimport {
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/components/ListComponent.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/list/src/dsl/List.tsx"],"sourcesContent":["import React from \"react\";\nimport { ListItem, OrderedList, UnorderedList } from \"@chakra-ui/react\";\nimport { ListAsset } from \"../types\";\nimport { ReactAsset } from \"@player-ui/react\";\n\nexport const ListComponent = (props: ListAsset) => {\n return props.metaData?.ordered ? (\n <UnorderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </UnorderedList>\n ) : (\n <OrderedList>\n {props.values &&\n props.values.map(({ asset }) => (\n <ListItem key={asset.id}>\n <ReactAsset {...asset} />\n </ListItem>\n ))}\n </OrderedList>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n} from \"@player-lang/react-dsl\";\nimport { Text } from \"@devtools-ui/text\";\nimport type { Asset as AssetType } from \"@player-ui/player\";\nimport { Collection } from \"@devtools-ui/collection\";\nimport { ListAsset } from \"../types\";\n\nexport const List = (props: AssetPropsWithChildren<ListAsset>) => (\n <Asset type={\"list\"} {...props}></Asset>\n);\n\nconst CollectionComp = (props: AssetPropsWithChildren<AssetType>) => {\n return (\n <Collection>\n <Collection.Values>{props.children}</Collection.Values>\n </Collection>\n );\n};\n\nList.Values = createSlot({\n name: \"values\",\n TextComp: Text,\n CollectionComp,\n isArray: true,\n wrapInAsset: true,\n});\n"],"mappings":";AAAA,OAAO,WAAW;AAClB,SAAS,UAAU,aAAa,qBAAqB;AAErD,SAAS,kBAAkB;AAEpB,IAAM,gBAAgB,CAAC,UAAqB;AACjD,SAAO,MAAM,UAAU,UACrB,oCAAC,qBACE,MAAM,UACL,MAAM,OAAO,IAAI,CAAC,EAAE,MAAM,MACxB,oCAAC,YAAS,KAAK,MAAM,MACnB,oCAAC,cAAY,GAAG,OAAO,CACzB,CACD,CACL,IAEA,oCAAC,mBACE,MAAM,UACL,MAAM,OAAO,IAAI,CAAC,EAAE,MAAM,MACxB,oCAAC,YAAS,KAAK,MAAM,MACnB,oCAAC,cAAY,GAAG,OAAO,CACzB,CACD,CACL;AAEJ;;;ACzBA,OAAOA,YAAW;AAClB;AAAA,EAEE;AAAA,EACA;AAAA,OACK;AACP,SAAS,YAAY;AAErB,SAAS,kBAAkB;AAGpB,IAAM,OAAO,CAAC,UACnB,gBAAAA,OAAA,cAAC,SAAM,MAAM,QAAS,GAAG,OAAO;AAGlC,IAAM,iBAAiB,CAAC,UAA6C;AACnE,SACE,gBAAAA,OAAA,cAAC,kBACC,gBAAAA,OAAA,cAAC,WAAW,QAAX,MAAmB,MAAM,QAAS,CACrC;AAEJ;AAEA,KAAK,SAAS,WAAW;AAAA,EACvB,MAAM;AAAA,EACN,UAAU;AAAA,EACV;AAAA,EACA,SAAS;AAAA,EACT,aAAa;AACf,CAAC;","names":["React"]}
|
package/package.json
CHANGED
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
{
|
|
2
|
+
"sideEffects": false,
|
|
3
|
+
"files": [
|
|
4
|
+
"dist",
|
|
5
|
+
"src",
|
|
6
|
+
"types"
|
|
7
|
+
],
|
|
2
8
|
"name": "@devtools-ui/list",
|
|
3
|
-
"version": "0.4.0",
|
|
9
|
+
"version": "0.4.1-next.0",
|
|
4
10
|
"main": "dist/cjs/index.cjs",
|
|
5
11
|
"dependencies": {
|
|
6
|
-
"@devtools-ui/collection": "0.4.0",
|
|
7
|
-
"@devtools-ui/text": "0.4.0",
|
|
12
|
+
"@devtools-ui/collection": "0.4.1-next.0",
|
|
13
|
+
"@devtools-ui/text": "0.4.1-next.0",
|
|
8
14
|
"@chakra-ui/react": "^2.8.2",
|
|
9
15
|
"@emotion/react": "^11.11.4",
|
|
10
16
|
"@emotion/styled": "^11.11.0",
|
|
@@ -16,7 +22,6 @@
|
|
|
16
22
|
},
|
|
17
23
|
"module": "dist/index.legacy-esm.js",
|
|
18
24
|
"types": "types/index.d.ts",
|
|
19
|
-
"sideEffects": false,
|
|
20
25
|
"exports": {
|
|
21
26
|
"./package.json": "./package.json",
|
|
22
27
|
"./dist/index.css": "./dist/index.css",
|
|
@@ -26,15 +31,10 @@
|
|
|
26
31
|
"default": "./dist/cjs/index.cjs"
|
|
27
32
|
}
|
|
28
33
|
},
|
|
29
|
-
"files": [
|
|
30
|
-
"dist",
|
|
31
|
-
"src",
|
|
32
|
-
"types"
|
|
33
|
-
],
|
|
34
34
|
"peerDependencies": {
|
|
35
|
-
"@player-
|
|
36
|
-
"@player-ui/types": "0.
|
|
37
|
-
"@player-ui/player": "0.
|
|
38
|
-
"@player-ui/react": "0.
|
|
35
|
+
"@player-lang/react-dsl": "1.0.1",
|
|
36
|
+
"@player-ui/types": "0.15.5",
|
|
37
|
+
"@player-ui/player": "0.15.5",
|
|
38
|
+
"@player-ui/react": "0.15.5"
|
|
39
39
|
}
|
|
40
40
|
}
|
package/src/dsl/List.tsx
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
import React from "react";
|
|
2
|
-
import {
|
|
2
|
+
import {
|
|
3
|
+
AssetPropsWithChildren,
|
|
4
|
+
Asset,
|
|
5
|
+
createSlot,
|
|
6
|
+
} from "@player-lang/react-dsl";
|
|
3
7
|
import { Text } from "@devtools-ui/text";
|
|
4
8
|
import type { Asset as AssetType } from "@player-ui/player";
|
|
5
9
|
import { Collection } from "@devtools-ui/collection";
|
package/types/dsl/List.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import React from "react";
|
|
2
|
-
import { AssetPropsWithChildren } from "@player-
|
|
2
|
+
import { AssetPropsWithChildren } from "@player-lang/react-dsl";
|
|
3
3
|
import { ListAsset } from "../types";
|
|
4
4
|
export declare const List: {
|
|
5
5
|
(props: AssetPropsWithChildren<ListAsset>): React.JSX.Element;
|