react-blockkit 0.3.3 → 0.4.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 +13 -6
- package/dist/blocks/AdvancedBlocks.d.ts.map +1 -1
- package/dist/blocks/BasicBlocks.d.ts.map +1 -1
- package/dist/blocks/InteractiveBlocks.d.ts.map +1 -1
- package/dist/elements/Elements.d.ts.map +1 -1
- package/dist/index.cjs +4 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +252 -249
- package/dist/index.js.map +1 -1
- package/dist/validation.d.ts.map +1 -1
- package/package.json +3 -3
- package/docs/coverage-matrix.md +0 -80
- package/docs/parity/chart-bar-3-w580-dark.png +0 -0
- package/docs/parity/chart-bar-3-w580-light.png +0 -0
- package/docs/parity/chart-line-3-w580-light.png +0 -0
- package/docs/parity/chart-pie-12-w400-light.png +0 -0
- package/docs/parity/chart-pie-5-w580-light.png +0 -0
- package/docs/parity/data-table-w580-dark.png +0 -0
- package/docs/parity/data-table-w580-light.png +0 -0
- package/docs/parity/headers-levels-w580-light.png +0 -0
- package/docs/parity/icons-alert-info.png +0 -0
- package/docs/parity/icons-card-slack-icon.png +0 -0
- package/docs/parity/icons-context-actions.png +0 -0
- package/docs/parity/icons-data-table-header.png +0 -0
- package/docs/parity/icons-datepicker.png +0 -0
- package/docs/parity/icons-overflow.png +0 -0
- package/docs/parity/icons-pagination.png +0 -0
- package/docs/parity/icons-select-chevron.png +0 -0
- package/docs/parity/rich-text-full-w580-light.png +0 -0
- package/docs/parity/spacing-rhythm-w580-light.png +0 -0
- package/docs/parity/table-align-wrap-w580-light.png +0 -0
- package/docs/parity/table-basic-w580-light.png +0 -0
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# react-blockkit
|
|
2
2
|
|
|
3
|
-
React components that render Slack Block Kit JSON
|
|
3
|
+
React components that render Slack Block Kit JSON at Slack's measured pixel
|
|
4
|
+
geometry, in both light and dark themes.
|
|
4
5
|
|
|
5
6
|
`react-blockkit` accepts any Block Kit payload; it is not coupled to a Markdown
|
|
6
7
|
source or compiler. The package uses Slack's official `@slack/types`
|
|
@@ -120,8 +121,12 @@ Standalone components use the same tolerant rendering behavior as
|
|
|
120
121
|
|
|
121
122
|
Rendering does not reject payloads based on the selected surface. Pass the same
|
|
122
123
|
surface to `assertBlockKitData` or `parseBlockKitData` when strict compatibility
|
|
123
|
-
checks are required.
|
|
124
|
-
|
|
124
|
+
checks are required. Thirteen block types are surface-restricted: `alert` is
|
|
125
|
+
modal-only, `input` is modal or home, and eleven message blocks (`card`,
|
|
126
|
+
`carousel`, `container`, `context_actions`, `data_table`, `data_visualization`,
|
|
127
|
+
`file`, `markdown`, `plan`, `table`, `task_card`) are message-only. The full
|
|
128
|
+
table is in the
|
|
129
|
+
[validation reference](https://slack.siraj.page/react-blockkit/docs/reference/validation).
|
|
125
130
|
|
|
126
131
|
## Resolve workspace references
|
|
127
132
|
|
|
@@ -169,8 +174,9 @@ assertBlockKitData(unknownPayload, "message");
|
|
|
169
174
|
const typed = parseBlockKitData(json, "message");
|
|
170
175
|
```
|
|
171
176
|
|
|
172
|
-
The
|
|
173
|
-
|
|
177
|
+
The full block, element, and rich-text inventory, with the degradation
|
|
178
|
+
behaviour for each, is in the
|
|
179
|
+
[blocks and elements reference](https://slack.siraj.page/react-blockkit/docs/reference/blocks-and-elements).
|
|
174
180
|
|
|
175
181
|
## Type source
|
|
176
182
|
|
|
@@ -198,5 +204,6 @@ pnpm --filter react-blockkit build
|
|
|
198
204
|
The build emits ESM, CJS, declarations, source maps, and a single
|
|
199
205
|
`dist/styles.css` containing the compiled StyleX atoms and theme variables.
|
|
200
206
|
|
|
201
|
-
|
|
207
|
+
The measured Slack Block Kit Builder values this renderer reproduces, covering
|
|
208
|
+
typography, block geometry, and per-control metrics in both themes, are in
|
|
202
209
|
[`docs/slack-style-baseline.md`](./docs/slack-style-baseline.md).
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdvancedBlocks.d.ts","sourceRoot":"","sources":["../../src/blocks/AdvancedBlocks.tsx"],"names":[],"mappings":"AACA,OAAO,EAAY,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AAsBpE,OAAO,KAAK,EACV,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,aAAa,EACb,iBAAiB,EAClB,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"AdvancedBlocks.d.ts","sourceRoot":"","sources":["../../src/blocks/AdvancedBlocks.tsx"],"names":[],"mappings":"AACA,OAAO,EAAY,KAAK,YAAY,EAAkB,MAAM,OAAO,CAAC;AAsBpE,OAAO,KAAK,EACV,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,aAAa,EACb,iBAAiB,EAClB,MAAM,aAAa,CAAC;AAerB,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACzD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS,CAAC;IAC3C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACxC;AAED,wBAAgB,SAAS,CAAC,EACxB,KAAc,EACd,IAAI,EACJ,SAAS,EACT,WAAmB,EACnB,MAAc,EACd,IAAa,EACb,KAAa,EACb,OAAe,GAChB,EAAE,cAAc,GAAG,YAAY,CA2C/B;AAMD,wBAAgB,UAAU,CAAC,EACzB,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAAG,YAAY,CA0CpD;AA0DD,wBAAgB,cAAc,CAAC,EAC7B,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,GAAG,YAAY,CA8KxD;AAoBD,wBAAgB,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,mBAAmB,CAAC,aAAa,CAAC,GAAG,YAAY,CA2DhG;AAMD,wBAAgB,aAAa,CAAC,EAC5B,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,GAAG,YAAY,CA4BvD;AAED,wBAAgB,UAAU,CAAC,EACzB,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAAG,YAAY,CA6BpD;AAED,wBAAgB,aAAa,CAAC,EAC5B,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,GAAG,YAAY,CA6DvD;AAMD,wBAAgB,SAAS,CAAC,EACxB,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,aAAa,CAAC,GAAG,YAAY,CA+BnD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BasicBlocks.d.ts","sourceRoot":"","sources":["../../src/blocks/BasicBlocks.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AASrD,OAAO,KAAK,EACV,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,eAAe,EAEf,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACf,MAAM,aAAa,CAAC;AAMrB,UAAU,UAAU;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED,oFAAoF;AACpF,wBAAgB,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,UAAU,GAAG,YAAY,
|
|
1
|
+
{"version":3,"file":"BasicBlocks.d.ts","sourceRoot":"","sources":["../../src/blocks/BasicBlocks.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AASrD,OAAO,KAAK,EACV,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,eAAe,EAEf,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,cAAc,EACf,MAAM,aAAa,CAAC;AAMrB,UAAU,UAAU;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED,oFAAoF;AACpF,wBAAgB,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,UAAU,GAAG,YAAY,CAa3F;AAED,wBAAgB,YAAY,CAAC,EAC3B,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,GAAG,YAAY,CA+BtD;AAED,wBAAgB,WAAW,CAAC,EAC1B,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,eAAe,CAAC,GAAG,YAAY,CAoCrD;AAED,wBAAgB,YAAY,CAAC,EAC3B,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,GAAG,YAAY,CAMtD;AAED,wBAAgB,UAAU,CAAC,EACzB,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAAG,YAAY,CASpD;AAmBD,wBAAgB,YAAY,CAAC,EAC3B,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,GAAG,YAAY,CA4CtD;AAED,wBAAgB,aAAa,CAAC,EAC5B,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,GAAG,YAAY,CAMvD;AAED,wBAAgB,aAAa,CAAC,EAC5B,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,GAAG,YAAY,CAQvD;AAED,wBAAgB,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,mBAAmB,CAAC,aAAa,CAAC,GAAG,YAAY,CAoBhG;AAED,wBAAgB,UAAU,CAAC,EACzB,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAAG,YAAY,CAqDpD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InteractiveBlocks.d.ts","sourceRoot":"","sources":["../../src/blocks/InteractiveBlocks.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAM1C,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACf,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"InteractiveBlocks.d.ts","sourceRoot":"","sources":["../../src/blocks/InteractiveBlocks.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAM1C,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACf,MAAM,aAAa,CAAC;AAuCrB,wBAAgB,YAAY,CAAC,EAC3B,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,GAAG,YAAY,CAwBtD;AAED,wBAAgB,UAAU,CAAC,EACzB,KAAK,EACL,SAAS,EACT,IAAc,GACf,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAAG,YAAY,CAkCpD;AAWD,wBAAgB,mBAAmB,CAAC,EAClC,KAAK,EACL,SAAS,GACV,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,GAAG,YAAY,CAqG7D"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Elements.d.ts","sourceRoot":"","sources":["../../src/elements/Elements.tsx"],"names":[],"mappings":"AACA,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,OAAO,CAAC;AAQnE,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EAEvB,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"Elements.d.ts","sourceRoot":"","sources":["../../src/elements/Elements.tsx"],"names":[],"mappings":"AACA,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,OAAO,CAAC;AAQnE,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EAEvB,MAAM,aAAa,CAAC;AA8MrB,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;CAClF;AAED,wBAAgB,YAAY,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,iBAAiB,GAAG,YAAY,CAqC7F;AAED,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;CACrC;AAED,wBAAgB,aAAa,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,kBAAkB,GAAG,YAAY,CA8C/F;AAED,KAAK,mBAAmB,GAAG,OAAO,CAAC,sBAAsB,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AAE1F,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;CACvC;AAED,wBAAgB,eAAe,CAAC,EAC9B,OAAO,EACP,SAAS,EACT,OAAO,GACR,EAAE,oBAAoB,GAAG,YAAY,CA4BrC;AAcD,UAAU,gBAAiB,SAAQ,kBAAkB;IACnD,QAAQ,CAAC,OAAO,EAAE,OAAO,CACvB,sBAAsB,EACtB;QAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,eAAe,CAAA;KAAE,CAClD,CAAC;CACH;AAED,wBAAgB,WAAW,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,gBAAgB,GAAG,YAAY,CAkE3F;AAmBD,KAAK,iBAAiB,GAAG,OAAO,CAC9B,sBAAsB,EACtB;IACE,QAAQ,CAAC,IAAI,EACT,iBAAiB,GACjB,sBAAsB,GACtB,iBAAiB,GACjB,uBAAuB,GACvB,4BAA4B,GAC5B,uBAAuB,GACvB,qBAAqB,GACrB,oBAAoB,GACpB,eAAe,GACf,cAAc,CAAC;CACpB,CACF,CAAC;AAsGF,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;CACrC;AAED,wBAAgB,aAAa,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,kBAAkB,GAAG,YAAY,CAsE/F;AAED,KAAK,gBAAgB,GAAG,OAAO,CAC7B,sBAAsB,EACtB;IACE,QAAQ,CAAC,IAAI,EACT,YAAY,GACZ,gBAAgB,GAChB,kBAAkB,GAClB,YAAY,GACZ,cAAc,GACd,kBAAkB,GAClB,iBAAiB,GACjB,YAAY,GACZ,gBAAgB,CAAC;CACtB,CACF,CAAC;AAEF,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAyCD,wBAAgB,YAAY,CAAC,EAC3B,OAAO,EACP,SAAS,EACT,OAAO,EACP,IAAgB,GACjB,EAAE,iBAAiB,GAAG,YAAY,CA4JlC;AAED,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,wBAAgB,kBAAkB,CAAC,EACjC,OAAO,EACP,SAAS,EACT,OAAO,EACP,IAAgB,GACjB,EAAE,uBAAuB,GAAG,YAAY,CAiDxC"}
|