@xyo-network/react-payload-plugin 2.41.37 → 2.41.38

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.
Files changed (6) hide show
  1. package/README.md +4 -61
  2. package/dist/docs.json +216 -216
  3. package/dist/types/XyoPayloadRenderPlugin.d.ts +9 -9
  4. package/dist/types/XyoPayloadRenderPlugin.d.ts.map +1 -1
  5. package/package.json +6 -6
  6. package/src/XyoPayloadRenderPlugin.ts +9 -9
package/dist/types/XyoPayloadRenderPlugin.d.ts CHANGED
@@ -7,21 +7,21 @@ export interface XyoPayloadRenderProps<T extends XyoPayload = XyoPayload> {
7
7
  payload?: T;
8
8
  }
9
9
  export interface XyoPayloadDetailsRenderProps extends XyoPayloadRenderProps {
10
- listMode?: ListMode;
11
10
  active?: boolean;
11
+ listMode?: ListMode;
12
12
  visibleRows?: number;
13
13
  }
14
14
  export interface XyoPayloadEditorRenderProps extends XyoPayloadDetailsRenderProps {
15
15
  onChange?: (payload: XyoPayload) => boolean;
16
16
  }
17
17
  export interface XyoPayloadRenderPluginBase {
18
- name: string;
19
18
  canRender: (payload?: XyoPayload) => boolean;
19
+ name: string;
20
20
  }
21
21
  export interface XyoPayloadRenderPluginCardComponents {
22
- header: ComponentType<XyoPayloadRenderProps & CardHeaderProps>;
23
- content: ComponentType<XyoPayloadRenderProps & CardContentProps>;
24
22
  actionArea: ComponentType<XyoPayloadRenderProps & CardActionAreaProps>;
23
+ content: ComponentType<XyoPayloadRenderProps & CardContentProps>;
24
+ header: ComponentType<XyoPayloadRenderProps & CardHeaderProps>;
25
25
  }
26
26
  export interface XyoPayloadRenderPluginAvatarComponents {
27
27
  image: ComponentType<XyoPayloadRenderProps & AvatarProps>;
@@ -30,24 +30,24 @@ export interface XyoPayloadRenderPluginTableComponents {
30
30
  cell: ComponentType<XyoPayloadRenderProps & TableCellProps>;
31
31
  }
32
32
  export interface XyoPayloadRenderPluginBoxComponents {
33
- listModes?: ListMode[];
34
33
  /** @deprecated - use detailsBox */
35
34
  details?: ComponentType<XyoPayloadDetailsRenderProps & FlexBoxProps>;
36
35
  detailsBox: ComponentType<XyoPayloadDetailsRenderProps & FlexBoxProps>;
37
36
  detailsCard?: ComponentType<XyoPayloadDetailsRenderProps & CardProps>;
38
37
  editor: ComponentType<XyoPayloadEditorRenderProps & FlexBoxProps>;
38
+ listModes?: ListMode[];
39
39
  }
40
40
  export interface XyoPayloadRenderPluginComponents {
41
+ avatar: XyoPayloadRenderPluginAvatarComponents;
42
+ box: XyoPayloadRenderPluginBoxComponents;
41
43
  card: XyoPayloadRenderPluginCardComponents;
42
44
  table: XyoPayloadRenderPluginTableComponents;
43
- box: XyoPayloadRenderPluginBoxComponents;
44
- avatar: XyoPayloadRenderPluginAvatarComponents;
45
45
  }
46
46
  export interface XyoPayloadRenderPluginComponentsConfig {
47
+ avatar?: Partial<XyoPayloadRenderPluginAvatarComponents>;
48
+ box?: Partial<XyoPayloadRenderPluginBoxComponents>;
47
49
  card?: Partial<XyoPayloadRenderPluginCardComponents>;
48
50
  table?: Partial<XyoPayloadRenderPluginTableComponents>;
49
- box?: Partial<XyoPayloadRenderPluginBoxComponents>;
50
- avatar?: Partial<XyoPayloadRenderPluginAvatarComponents>;
51
51
  }
52
52
  export interface XyoPayloadRenderPlugin extends XyoPayloadRenderPluginBase {
53
53
  components: XyoPayloadRenderPluginComponents;
package/dist/types/XyoPayloadRenderPlugin.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"XyoPayloadRenderPlugin.d.ts","sourceRoot":"","sources":["../../src/XyoPayloadRenderPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9H,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAErC,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IACtE,OAAO,CAAC,EAAE,CAAC,CAAA;CACZ;AAED,MAAM,WAAW,4BAA6B,SAAQ,qBAAqB;IACzE,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,2BAA4B,SAAQ,4BAA4B;IAC/E,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAA;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,KAAK,OAAO,CAAA;CAC7C;AAED,MAAM,WAAW,oCAAoC;IACnD,MAAM,EAAE,aAAa,CAAC,qBAAqB,GAAG,eAAe,CAAC,CAAA;IAC9D,OAAO,EAAE,aAAa,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAA;IAChE,UAAU,EAAE,aAAa,CAAC,qBAAqB,GAAG,mBAAmB,CAAC,CAAA;CACvE;AAED,MAAM,WAAW,sCAAsC;IACrD,KAAK,EAAE,aAAa,CAAC,qBAAqB,GAAG,WAAW,CAAC,CAAA;CAC1D;AAED,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE,aAAa,CAAC,qBAAqB,GAAG,cAAc,CAAC,CAAA;CAC5D;AAED,MAAM,WAAW,mCAAmC;IAClD,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB,oCAAoC;IACpC,OAAO,CAAC,EAAE,aAAa,CAAC,4BAA4B,GAAG,YAAY,CAAC,CAAA;IACpE,UAAU,EAAE,aAAa,CAAC,4BAA4B,GAAG,YAAY,CAAC,CAAA;IACtE,WAAW,CAAC,EAAE,aAAa,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IACrE,MAAM,EAAE,aAAa,CAAC,2BAA2B,GAAG,YAAY,CAAC,CAAA;CAClE;AAED,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,oCAAoC,CAAA;IAC1C,KAAK,EAAE,qCAAqC,CAAA;IAC5C,GAAG,EAAE,mCAAmC,CAAA;IACxC,MAAM,EAAE,sCAAsC,CAAA;CAC/C;AAED,MAAM,WAAW,sCAAsC;IACrD,IAAI,CAAC,EAAE,OAAO,CAAC,oCAAoC,CAAC,CAAA;IACpD,KAAK,CAAC,EAAE,OAAO,CAAC,qCAAqC,CAAC,CAAA;IACtD,GAAG,CAAC,EAAE,OAAO,CAAC,mCAAmC,CAAC,CAAA;IAClD,MAAM,CAAC,EAAE,OAAO,CAAC,sCAAsC,CAAC,CAAA;CACzD;AAED,MAAM,WAAW,sBAAuB,SAAQ,0BAA0B;IACxE,UAAU,EAAE,gCAAgC,CAAA;CAC7C;AAED,MAAM,WAAW,4BAA6B,SAAQ,0BAA0B;IAC9E,UAAU,CAAC,EAAE,sCAAsC,CAAA;CACpD"}
1
+ {"version":3,"file":"XyoPayloadRenderPlugin.d.ts","sourceRoot":"","sources":["../../src/XyoPayloadRenderPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9H,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAErC,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IACtE,OAAO,CAAC,EAAE,CAAC,CAAA;CACZ;AAED,MAAM,WAAW,4BAA6B,SAAQ,qBAAqB;IACzE,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,2BAA4B,SAAQ,4BAA4B;IAC/E,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAA;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,KAAK,OAAO,CAAA;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,oCAAoC;IACnD,UAAU,EAAE,aAAa,CAAC,qBAAqB,GAAG,mBAAmB,CAAC,CAAA;IACtE,OAAO,EAAE,aAAa,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAA;IAChE,MAAM,EAAE,aAAa,CAAC,qBAAqB,GAAG,eAAe,CAAC,CAAA;CAC/D;AAED,MAAM,WAAW,sCAAsC;IACrD,KAAK,EAAE,aAAa,CAAC,qBAAqB,GAAG,WAAW,CAAC,CAAA;CAC1D;AAED,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE,aAAa,CAAC,qBAAqB,GAAG,cAAc,CAAC,CAAA;CAC5D;AAED,MAAM,WAAW,mCAAmC;IAClD,oCAAoC;IACpC,OAAO,CAAC,EAAE,aAAa,CAAC,4BAA4B,GAAG,YAAY,CAAC,CAAA;IACpE,UAAU,EAAE,aAAa,CAAC,4BAA4B,GAAG,YAAY,CAAC,CAAA;IACtE,WAAW,CAAC,EAAE,aAAa,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IACrE,MAAM,EAAE,aAAa,CAAC,2BAA2B,GAAG,YAAY,CAAC,CAAA;IACjE,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,sCAAsC,CAAA;IAC9C,GAAG,EAAE,mCAAmC,CAAA;IACxC,IAAI,EAAE,oCAAoC,CAAA;IAC1C,KAAK,EAAE,qCAAqC,CAAA;CAC7C;AAED,MAAM,WAAW,sCAAsC;IACrD,MAAM,CAAC,EAAE,OAAO,CAAC,sCAAsC,CAAC,CAAA;IACxD,GAAG,CAAC,EAAE,OAAO,CAAC,mCAAmC,CAAC,CAAA;IAClD,IAAI,CAAC,EAAE,OAAO,CAAC,oCAAoC,CAAC,CAAA;IACpD,KAAK,CAAC,EAAE,OAAO,CAAC,qCAAqC,CAAC,CAAA;CACvD;AAED,MAAM,WAAW,sBAAuB,SAAQ,0BAA0B;IACxE,UAAU,EAAE,gCAAgC,CAAA;CAC7C;AAED,MAAM,WAAW,4BAA6B,SAAQ,0BAA0B;IAC9E,UAAU,CAAC,EAAE,sCAAsC,CAAA;CACpD"}
package/package.json CHANGED
@@ -12,14 +12,14 @@
12
12
  "dependencies": {
13
13
  "@xylabs/react-flexbox": "^2.15.11",
14
14
  "@xylabs/react-identicon": "^2.15.11",
15
- "@xyo-network/payload-model": "^2.43.13",
16
- "@xyo-network/payload-wrapper": "^2.43.13",
17
- "@xyo-network/react-payload-details": "^2.41.37",
18
- "@xyo-network/react-shared": "^2.41.37",
15
+ "@xyo-network/payload-model": "^2.43.22",
16
+ "@xyo-network/payload-wrapper": "^2.43.22",
17
+ "@xyo-network/react-payload-details": "^2.41.38",
18
+ "@xyo-network/react-shared": "^2.41.38",
19
19
  "lodash": "^4.17.21"
20
20
  },
21
21
  "devDependencies": {
22
- "@xylabs/ts-scripts-yarn3": "2.12.26"
22
+ "@xylabs/ts-scripts-yarn3": "2.12.29"
23
23
  },
24
24
  "peerDependencies": {
25
25
  "@mui/icons-material": "^5",
@@ -72,5 +72,5 @@
72
72
  },
73
73
  "sideEffects": false,
74
74
  "types": "dist/types/index.d.ts",
75
- "version": "2.41.37"
75
+ "version": "2.41.38"
76
76
  }
package/src/XyoPayloadRenderPlugin.ts CHANGED
@@ -9,8 +9,8 @@ export interface XyoPayloadRenderProps<T extends XyoPayload = XyoPayload> {
9
9
  }
10
10
 
11
11
  export interface XyoPayloadDetailsRenderProps extends XyoPayloadRenderProps {
12
- listMode?: ListMode
13
12
  active?: boolean
13
+ listMode?: ListMode
14
14
  visibleRows?: number
15
15
  }
16
16
 
@@ -19,14 +19,14 @@ export interface XyoPayloadEditorRenderProps extends XyoPayloadDetailsRenderProp
19
19
  }
20
20
 
21
21
  export interface XyoPayloadRenderPluginBase {
22
- name: string
23
22
  canRender: (payload?: XyoPayload) => boolean
23
+ name: string
24
24
  }
25
25
 
26
26
  export interface XyoPayloadRenderPluginCardComponents {
27
- header: ComponentType<XyoPayloadRenderProps & CardHeaderProps>
28
- content: ComponentType<XyoPayloadRenderProps & CardContentProps>
29
27
  actionArea: ComponentType<XyoPayloadRenderProps & CardActionAreaProps>
28
+ content: ComponentType<XyoPayloadRenderProps & CardContentProps>
29
+ header: ComponentType<XyoPayloadRenderProps & CardHeaderProps>
30
30
  }
31
31
 
32
32
  export interface XyoPayloadRenderPluginAvatarComponents {
@@ -38,26 +38,26 @@ export interface XyoPayloadRenderPluginTableComponents {
38
38
  }
39
39
 
40
40
  export interface XyoPayloadRenderPluginBoxComponents {
41
- listModes?: ListMode[]
42
41
  /** @deprecated - use detailsBox */
43
42
  details?: ComponentType<XyoPayloadDetailsRenderProps & FlexBoxProps>
44
43
  detailsBox: ComponentType<XyoPayloadDetailsRenderProps & FlexBoxProps>
45
44
  detailsCard?: ComponentType<XyoPayloadDetailsRenderProps & CardProps>
46
45
  editor: ComponentType<XyoPayloadEditorRenderProps & FlexBoxProps>
46
+ listModes?: ListMode[]
47
47
  }
48
48
 
49
49
  export interface XyoPayloadRenderPluginComponents {
50
+ avatar: XyoPayloadRenderPluginAvatarComponents
51
+ box: XyoPayloadRenderPluginBoxComponents
50
52
  card: XyoPayloadRenderPluginCardComponents
51
53
  table: XyoPayloadRenderPluginTableComponents
52
- box: XyoPayloadRenderPluginBoxComponents
53
- avatar: XyoPayloadRenderPluginAvatarComponents
54
54
  }
55
55
 
56
56
  export interface XyoPayloadRenderPluginComponentsConfig {
57
+ avatar?: Partial<XyoPayloadRenderPluginAvatarComponents>
58
+ box?: Partial<XyoPayloadRenderPluginBoxComponents>
57
59
  card?: Partial<XyoPayloadRenderPluginCardComponents>
58
60
  table?: Partial<XyoPayloadRenderPluginTableComponents>
59
- box?: Partial<XyoPayloadRenderPluginBoxComponents>
60
- avatar?: Partial<XyoPayloadRenderPluginAvatarComponents>
61
61
  }
62
62
 
63
63
  export interface XyoPayloadRenderPlugin extends XyoPayloadRenderPluginBase {