@devtools-ui/toggle 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 +99 -0
- package/dist/cjs/index.cjs +3 -3
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.legacy-esm.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +14 -14
- package/src/dsl/__tests__/index.test.tsx +1 -1
- package/src/dsl/index.tsx +1 -1
- package/types/dsl/index.d.ts +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# @devtools-ui/toggle
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
`@devtools-ui/toggle` 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 `Toggle` component that can be used to enter a boolean represented value.
|
|
8
|
+
|
|
9
|
+
This package is part of a mono-repo built with Bazel, ensuring fast and reliable builds.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
To install `@devtools-ui/toggle`, you can use pnpm or yarn:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
pnpm i @devtools-ui/toggle
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
or
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
yarn add @devtools-ui/toggle
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
You can leverage this asset through the `@devtools-ui/plugin`:
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { Toggle } from "@devtools-ui/plugin";
|
|
31
|
+
|
|
32
|
+
// and use it to define your Player-UI content:
|
|
33
|
+
myFlow = {
|
|
34
|
+
id: 'my_flow',
|
|
35
|
+
views: [
|
|
36
|
+
<>
|
|
37
|
+
<Toggle>
|
|
38
|
+
<Toggle.Label>
|
|
39
|
+
Toggle Test
|
|
40
|
+
</Toggle.Label>
|
|
41
|
+
</Toggle>
|
|
42
|
+
</>
|
|
43
|
+
]
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
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).
|
|
48
|
+
|
|
49
|
+
Or, your can leverage this asset in your own plugin:
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
// TransformPlugin.ts
|
|
53
|
+
import type { Player, PlayerPlugin } from "@player-ui/player";
|
|
54
|
+
import { AssetTransformPlugin } from "@player-ui/asset-transform-plugin";
|
|
55
|
+
import { toggleTransform } from "@devtools-ui/toggle";
|
|
56
|
+
|
|
57
|
+
export class TransformsPlugin implements PlayerPlugin {
|
|
58
|
+
name = "my-plugin-transforms";
|
|
59
|
+
|
|
60
|
+
apply(player: Player) {
|
|
61
|
+
player.registerPlugin(
|
|
62
|
+
new AssetTransformPlugin([
|
|
63
|
+
[{ type: "toggle" }, toggleTransform],
|
|
64
|
+
])
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
// AssetRegistryPlugin.ts
|
|
72
|
+
import React from "react";
|
|
73
|
+
import type { Player } from "@player-ui/player";
|
|
74
|
+
import type {
|
|
75
|
+
ExtendedPlayerPlugin,
|
|
76
|
+
ReactPlayer,
|
|
77
|
+
ReactPlayerPlugin,
|
|
78
|
+
} from "@player-ui/react";
|
|
79
|
+
import { AssetProviderPlugin } from "@player-ui/asset-provider-plugin-react";
|
|
80
|
+
import { TransformsPlugin } from "./TransformPlugin";
|
|
81
|
+
import { ToggleAsset, ToggleComponent } from "@devtools-ui/toggle";
|
|
82
|
+
|
|
83
|
+
export class AssetsRegistryPlugin implements ReactPlayerPlugin, ExtendedPlayerPlugin<[ToggleAsset]> {
|
|
84
|
+
name = "my-plugin";
|
|
85
|
+
|
|
86
|
+
applyReact(reactPlayer: ReactPlayer) {
|
|
87
|
+
reactPlayer.registerPlugin(
|
|
88
|
+
new AssetProviderPlugin([
|
|
89
|
+
["toggle", ToggleComponent],
|
|
90
|
+
])
|
|
91
|
+
);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
apply(player: Player) {
|
|
95
|
+
player.registerPlugin(new TransformsPlugin());
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
package/dist/cjs/index.cjs
CHANGED
|
@@ -50,13 +50,13 @@ var ToggleComponent = (props) => {
|
|
|
50
50
|
|
|
51
51
|
// ../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/dsl/index.tsx
|
|
52
52
|
var import_react4 = __toESM(require("react"));
|
|
53
|
-
var
|
|
53
|
+
var import_react_dsl = require("@player-lang/react-dsl");
|
|
54
54
|
var import_text = require("@devtools-ui/text");
|
|
55
55
|
var Toggle = (props) => {
|
|
56
56
|
const { children, binding, ...rest } = props;
|
|
57
|
-
return /* @__PURE__ */ import_react4.default.createElement(
|
|
57
|
+
return /* @__PURE__ */ import_react4.default.createElement(import_react_dsl.Asset, { type: "toggle", ...rest }, /* @__PURE__ */ import_react4.default.createElement("property", { name: "binding" }, binding.toValue()), props.children);
|
|
58
58
|
};
|
|
59
|
-
Toggle.Label = (0,
|
|
59
|
+
Toggle.Label = (0, import_react_dsl.createSlot)({
|
|
60
60
|
name: "label",
|
|
61
61
|
TextComp: import_text.Text,
|
|
62
62
|
isArray: false,
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/component/index.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/dsl/index.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/transform/index.ts"],"sourcesContent":["export * from \"./types\";\nexport * from \"./component\";\nexport * from \"./dsl\";\nexport * from \"./transform\";\n","import React from \"react\";\nimport { Switch, FormControl, FormLabel } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport type { TransformedToggle } from \"../types\";\n\nexport const ToggleComponent = (props: TransformedToggle) => {\n const { value, label, id, setCheck } = props;\n\n const onChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {\n setCheck(e.target.checked);\n };\n\n return (\n <FormControl display=\"flex\" alignItems=\"center\">\n {label && (\n <FormLabel htmlFor={id}>\n <ReactAsset {...label.asset} />\n </FormLabel>\n )}\n <Switch id={id} onChange={onChange} />\n </FormControl>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n BindingTemplateInstance,\n} from \"@player-
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/component/index.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/dsl/index.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/transform/index.ts"],"sourcesContent":["export * from \"./types\";\nexport * from \"./component\";\nexport * from \"./dsl\";\nexport * from \"./transform\";\n","import React from \"react\";\nimport { Switch, FormControl, FormLabel } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport type { TransformedToggle } from \"../types\";\n\nexport const ToggleComponent = (props: TransformedToggle) => {\n const { value, label, id, setCheck } = props;\n\n const onChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {\n setCheck(e.target.checked);\n };\n\n return (\n <FormControl display=\"flex\" alignItems=\"center\">\n {label && (\n <FormLabel htmlFor={id}>\n <ReactAsset {...label.asset} />\n </FormLabel>\n )}\n <Switch id={id} onChange={onChange} />\n </FormControl>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n BindingTemplateInstance,\n} from \"@player-lang/react-dsl\";\nimport { Text } from \"@devtools-ui/text\";\nimport type { ToggleAsset } from \"../types\";\n\nexport const Toggle = (\n props: Omit<AssetPropsWithChildren<ToggleAsset>, \"binding\"> & {\n /** The binding as a tagged template instance */\n binding: BindingTemplateInstance;\n }\n) => {\n const { children, binding, ...rest } = props;\n\n return (\n <Asset type=\"toggle\" {...rest}>\n <property name=\"binding\">{binding.toValue()}</property>\n {props.children}\n </Asset>\n );\n};\n\nToggle.Label = createSlot({\n name: \"label\",\n TextComp: Text,\n isArray: false,\n wrapInAsset: true,\n});\n","import type { TransformFunction } from \"@player-ui/player\";\nimport { ToggleAsset, TransformedToggle } from \"../types\";\n\nexport const toggleTransform: TransformFunction<\n ToggleAsset,\n TransformedToggle\n> = (asset, options) => {\n return {\n ...asset,\n setCheck(val) {\n if (asset.binding === undefined) {\n return;\n }\n\n return options.data.model.set([[asset.binding, val]]);\n },\n value:\n asset.binding === undefined ? \"\" : options.data.model.get(asset.binding),\n };\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAkB;AAClB,IAAAA,gBAA+C;AAC/C,IAAAA,gBAA2B;AAGpB,IAAM,kBAAkB,CAAC,UAA6B;AAC3D,QAAM,EAAE,OAAO,OAAO,IAAI,SAAS,IAAI;AAEvC,QAAM,WAAuD,CAAC,MAAM;AAClE,aAAS,EAAE,OAAO,OAAO;AAAA,EAC3B;AAEA,SACE,6BAAAC,QAAA,cAAC,6BAAY,SAAQ,QAAO,YAAW,YACpC,SACC,6BAAAA,QAAA,cAAC,2BAAU,SAAS,MAClB,6BAAAA,QAAA,cAAC,4BAAY,GAAG,MAAM,OAAO,CAC/B,GAEF,6BAAAA,QAAA,cAAC,wBAAO,IAAQ,UAAoB,CACtC;AAEJ;;;ACtBA,IAAAC,gBAAkB;AAClB,uBAKO;AACP,kBAAqB;AAGd,IAAM,SAAS,CACpB,UAIG;AACH,QAAM,EAAE,UAAU,SAAS,GAAG,KAAK,IAAI;AAEvC,SACE,8BAAAC,QAAA,cAAC,0BAAM,MAAK,UAAU,GAAG,QACvB,8BAAAA,QAAA,cAAC,cAAS,MAAK,aAAW,QAAQ,QAAQ,CAAE,GAC3C,MAAM,QACT;AAEJ;AAEA,OAAO,YAAQ,6BAAW;AAAA,EACxB,MAAM;AAAA,EACN,UAAU;AAAA,EACV,SAAS;AAAA,EACT,aAAa;AACf,CAAC;;;AC5BM,IAAM,kBAGT,CAAC,OAAO,YAAY;AACtB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,SAAS,KAAK;AACZ,UAAI,MAAM,YAAY,QAAW;AAC/B;AAAA,MACF;AAEA,aAAO,QAAQ,KAAK,MAAM,IAAI,CAAC,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC;AAAA,IACtD;AAAA,IACA,OACE,MAAM,YAAY,SAAY,KAAK,QAAQ,KAAK,MAAM,IAAI,MAAM,OAAO;AAAA,EAC3E;AACF;","names":["import_react","React","import_react","React"]}
|
package/dist/index.legacy-esm.js
CHANGED
package/dist/index.mjs
CHANGED
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/component/index.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/dsl/index.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/transform/index.ts"],"sourcesContent":["import React from \"react\";\nimport { Switch, FormControl, FormLabel } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport type { TransformedToggle } from \"../types\";\n\nexport const ToggleComponent = (props: TransformedToggle) => {\n const { value, label, id, setCheck } = props;\n\n const onChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {\n setCheck(e.target.checked);\n };\n\n return (\n <FormControl display=\"flex\" alignItems=\"center\">\n {label && (\n <FormLabel htmlFor={id}>\n <ReactAsset {...label.asset} />\n </FormLabel>\n )}\n <Switch id={id} onChange={onChange} />\n </FormControl>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n BindingTemplateInstance,\n} from \"@player-
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/component/index.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/dsl/index.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/toggle/src/transform/index.ts"],"sourcesContent":["import React from \"react\";\nimport { Switch, FormControl, FormLabel } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport type { TransformedToggle } from \"../types\";\n\nexport const ToggleComponent = (props: TransformedToggle) => {\n const { value, label, id, setCheck } = props;\n\n const onChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {\n setCheck(e.target.checked);\n };\n\n return (\n <FormControl display=\"flex\" alignItems=\"center\">\n {label && (\n <FormLabel htmlFor={id}>\n <ReactAsset {...label.asset} />\n </FormLabel>\n )}\n <Switch id={id} onChange={onChange} />\n </FormControl>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n BindingTemplateInstance,\n} from \"@player-lang/react-dsl\";\nimport { Text } from \"@devtools-ui/text\";\nimport type { ToggleAsset } from \"../types\";\n\nexport const Toggle = (\n props: Omit<AssetPropsWithChildren<ToggleAsset>, \"binding\"> & {\n /** The binding as a tagged template instance */\n binding: BindingTemplateInstance;\n }\n) => {\n const { children, binding, ...rest } = props;\n\n return (\n <Asset type=\"toggle\" {...rest}>\n <property name=\"binding\">{binding.toValue()}</property>\n {props.children}\n </Asset>\n );\n};\n\nToggle.Label = createSlot({\n name: \"label\",\n TextComp: Text,\n isArray: false,\n wrapInAsset: true,\n});\n","import type { TransformFunction } from \"@player-ui/player\";\nimport { ToggleAsset, TransformedToggle } from \"../types\";\n\nexport const toggleTransform: TransformFunction<\n ToggleAsset,\n TransformedToggle\n> = (asset, options) => {\n return {\n ...asset,\n setCheck(val) {\n if (asset.binding === undefined) {\n return;\n }\n\n return options.data.model.set([[asset.binding, val]]);\n },\n value:\n asset.binding === undefined ? \"\" : options.data.model.get(asset.binding),\n };\n};\n"],"mappings":";AAAA,OAAO,WAAW;AAClB,SAAS,QAAQ,aAAa,iBAAiB;AAC/C,SAAS,kBAAkB;AAGpB,IAAM,kBAAkB,CAAC,UAA6B;AAC3D,QAAM,EAAE,OAAO,OAAO,IAAI,SAAS,IAAI;AAEvC,QAAM,WAAuD,CAAC,MAAM;AAClE,aAAS,EAAE,OAAO,OAAO;AAAA,EAC3B;AAEA,SACE,oCAAC,eAAY,SAAQ,QAAO,YAAW,YACpC,SACC,oCAAC,aAAU,SAAS,MAClB,oCAAC,cAAY,GAAG,MAAM,OAAO,CAC/B,GAEF,oCAAC,UAAO,IAAQ,UAAoB,CACtC;AAEJ;;;ACtBA,OAAOA,YAAW;AAClB;AAAA,EAEE;AAAA,EACA;AAAA,OAEK;AACP,SAAS,YAAY;AAGd,IAAM,SAAS,CACpB,UAIG;AACH,QAAM,EAAE,UAAU,SAAS,GAAG,KAAK,IAAI;AAEvC,SACE,gBAAAA,OAAA,cAAC,SAAM,MAAK,UAAU,GAAG,QACvB,gBAAAA,OAAA,cAAC,cAAS,MAAK,aAAW,QAAQ,QAAQ,CAAE,GAC3C,MAAM,QACT;AAEJ;AAEA,OAAO,QAAQ,WAAW;AAAA,EACxB,MAAM;AAAA,EACN,UAAU;AAAA,EACV,SAAS;AAAA,EACT,aAAa;AACf,CAAC;;;AC5BM,IAAM,kBAGT,CAAC,OAAO,YAAY;AACtB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,SAAS,KAAK;AACZ,UAAI,MAAM,YAAY,QAAW;AAC/B;AAAA,MACF;AAEA,aAAO,QAAQ,KAAK,MAAM,IAAI,CAAC,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC;AAAA,IACtD;AAAA,IACA,OACE,MAAM,YAAY,SAAY,KAAK,QAAQ,KAAK,MAAM,IAAI,MAAM,OAAO;AAAA,EAC3E;AACF;","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/toggle",
|
|
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/text": "0.4.0",
|
|
7
|
-
"@devtools-ui/collection": "0.4.0",
|
|
12
|
+
"@devtools-ui/text": "0.4.1-next.0",
|
|
13
|
+
"@devtools-ui/collection": "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,16 +31,11 @@
|
|
|
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/asset-transform-plugin": "0.
|
|
37
|
-
"@player-ui/player": "0.
|
|
38
|
-
"@player-ui/react": "0.
|
|
39
|
-
"@player-ui/types": "0.
|
|
35
|
+
"@player-lang/react-dsl": "1.0.1",
|
|
36
|
+
"@player-ui/asset-transform-plugin": "0.15.5",
|
|
37
|
+
"@player-ui/player": "0.15.5",
|
|
38
|
+
"@player-ui/react": "0.15.5",
|
|
39
|
+
"@player-ui/types": "0.15.5"
|
|
40
40
|
}
|
|
41
41
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import { describe, expect, test } from "vitest";
|
|
3
|
-
import { render, expression as e, binding as b } from "@player-
|
|
3
|
+
import { render, expression as e, binding as b } from "@player-lang/react-dsl";
|
|
4
4
|
import { Toggle } from "../";
|
|
5
5
|
|
|
6
6
|
describe("DSL: Toggle", () => {
|
package/src/dsl/index.tsx
CHANGED
package/types/dsl/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import React from "react";
|
|
2
|
-
import { AssetPropsWithChildren, BindingTemplateInstance } from "@player-
|
|
2
|
+
import { AssetPropsWithChildren, BindingTemplateInstance } from "@player-lang/react-dsl";
|
|
3
3
|
import type { ToggleAsset } from "../types";
|
|
4
4
|
export declare const Toggle: {
|
|
5
5
|
(props: Omit<AssetPropsWithChildren<ToggleAsset>, "binding"> & {
|