@starlightcms/react-sdk 0.8.0 → 0.9.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 +57 -0
- package/dist/cjs/ResponsiveImage/index.d.ts +61 -13
- package/dist/cjs/ResponsiveImage/index.d.ts.map +1 -1
- package/dist/cjs/ResponsiveImage/index.js +63 -1
- package/dist/cjs/ResponsiveImage/index.js.map +1 -1
- package/dist/cjs/ResponsiveImage/types.d.ts +52 -0
- package/dist/cjs/ResponsiveImage/types.d.ts.map +1 -0
- package/dist/cjs/ResponsiveImage/types.js +3 -0
- package/dist/cjs/ResponsiveImage/types.js.map +1 -0
- package/dist/cjs/VisualContent/blocks/HTML.d.ts +11 -0
- package/dist/cjs/VisualContent/blocks/HTML.d.ts.map +1 -1
- package/dist/cjs/VisualContent/blocks/HTML.js +11 -0
- package/dist/cjs/VisualContent/blocks/HTML.js.map +1 -1
- package/dist/cjs/VisualContent/blocks/Header.d.ts +13 -2
- package/dist/cjs/VisualContent/blocks/Header.d.ts.map +1 -1
- package/dist/cjs/VisualContent/blocks/Header.js +11 -0
- package/dist/cjs/VisualContent/blocks/Header.js.map +1 -1
- package/dist/cjs/VisualContent/blocks/Image.d.ts +21 -1
- package/dist/cjs/VisualContent/blocks/Image.d.ts.map +1 -1
- package/dist/cjs/VisualContent/blocks/Image.js +22 -1
- package/dist/cjs/VisualContent/blocks/Image.js.map +1 -1
- package/dist/cjs/VisualContent/blocks/List.d.ts +11 -0
- package/dist/cjs/VisualContent/blocks/List.d.ts.map +1 -1
- package/dist/cjs/VisualContent/blocks/List.js +11 -0
- package/dist/cjs/VisualContent/blocks/List.js.map +1 -1
- package/dist/cjs/VisualContent/blocks/Paragraph.d.ts +11 -0
- package/dist/cjs/VisualContent/blocks/Paragraph.d.ts.map +1 -1
- package/dist/cjs/VisualContent/blocks/Paragraph.js +11 -0
- package/dist/cjs/VisualContent/blocks/Paragraph.js.map +1 -1
- package/dist/cjs/VisualContent/blocks/Quote.d.ts +11 -0
- package/dist/cjs/VisualContent/blocks/Quote.d.ts.map +1 -1
- package/dist/cjs/VisualContent/blocks/Quote.js +11 -0
- package/dist/cjs/VisualContent/blocks/Quote.js.map +1 -1
- package/dist/cjs/VisualContent/index.d.ts +55 -3
- package/dist/cjs/VisualContent/index.d.ts.map +1 -1
- package/dist/cjs/VisualContent/index.js +56 -1
- package/dist/cjs/VisualContent/index.js.map +1 -1
- package/dist/cjs/VisualContent/styles.d.ts +11 -0
- package/dist/cjs/VisualContent/styles.d.ts.map +1 -1
- package/dist/cjs/VisualContent/styles.js +11 -0
- package/dist/cjs/VisualContent/styles.js.map +1 -1
- package/dist/cjs/VisualContent/types.d.ts +22 -2
- package/dist/cjs/VisualContent/types.d.ts.map +1 -1
- package/dist/cjs/VisualContent/types.js.map +1 -1
- package/dist/cjs/index.js +5 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/ResponsiveImage/index.d.ts +61 -13
- package/dist/esm/ResponsiveImage/index.d.ts.map +1 -1
- package/dist/esm/ResponsiveImage/index.js +59 -1
- package/dist/esm/ResponsiveImage/index.js.map +1 -1
- package/dist/esm/ResponsiveImage/types.d.ts +52 -0
- package/dist/esm/ResponsiveImage/types.d.ts.map +1 -0
- package/dist/esm/ResponsiveImage/types.js +2 -0
- package/dist/esm/ResponsiveImage/types.js.map +1 -0
- package/dist/esm/VisualContent/blocks/HTML.d.ts +11 -0
- package/dist/esm/VisualContent/blocks/HTML.d.ts.map +1 -1
- package/dist/esm/VisualContent/blocks/HTML.js +11 -0
- package/dist/esm/VisualContent/blocks/HTML.js.map +1 -1
- package/dist/esm/VisualContent/blocks/Header.d.ts +13 -2
- package/dist/esm/VisualContent/blocks/Header.d.ts.map +1 -1
- package/dist/esm/VisualContent/blocks/Header.js +11 -0
- package/dist/esm/VisualContent/blocks/Header.js.map +1 -1
- package/dist/esm/VisualContent/blocks/Image.d.ts +21 -1
- package/dist/esm/VisualContent/blocks/Image.d.ts.map +1 -1
- package/dist/esm/VisualContent/blocks/Image.js +17 -0
- package/dist/esm/VisualContent/blocks/Image.js.map +1 -1
- package/dist/esm/VisualContent/blocks/List.d.ts +11 -0
- package/dist/esm/VisualContent/blocks/List.d.ts.map +1 -1
- package/dist/esm/VisualContent/blocks/List.js +11 -0
- package/dist/esm/VisualContent/blocks/List.js.map +1 -1
- package/dist/esm/VisualContent/blocks/Paragraph.d.ts +11 -0
- package/dist/esm/VisualContent/blocks/Paragraph.d.ts.map +1 -1
- package/dist/esm/VisualContent/blocks/Paragraph.js +11 -0
- package/dist/esm/VisualContent/blocks/Paragraph.js.map +1 -1
- package/dist/esm/VisualContent/blocks/Quote.d.ts +11 -0
- package/dist/esm/VisualContent/blocks/Quote.d.ts.map +1 -1
- package/dist/esm/VisualContent/blocks/Quote.js +11 -0
- package/dist/esm/VisualContent/blocks/Quote.js.map +1 -1
- package/dist/esm/VisualContent/index.d.ts +55 -3
- package/dist/esm/VisualContent/index.d.ts.map +1 -1
- package/dist/esm/VisualContent/index.js +51 -0
- package/dist/esm/VisualContent/index.js.map +1 -1
- package/dist/esm/VisualContent/styles.d.ts +11 -0
- package/dist/esm/VisualContent/styles.d.ts.map +1 -1
- package/dist/esm/VisualContent/styles.js +11 -0
- package/dist/esm/VisualContent/styles.js.map +1 -1
- package/dist/esm/VisualContent/types.d.ts +22 -2
- package/dist/esm/VisualContent/types.d.ts.map +1 -1
- package/dist/esm/VisualContent/types.js.map +1 -1
- package/package.json +8 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/VisualContent/types.ts"],"names":[],"mappings":"","sourcesContent":["import { ComponentType } from 'react'\nimport {\n HeaderBlock,\n ImageBlock,\n ParagraphBlock,\n QuoteBlock,\n VisualData,\n VisualDataBlock,\n BlockType,\n HTMLBlock,\n ListBlock,\n} from '@starlightcms/js-sdk'\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\ntype Implements<T, U extends T> = Record<string, unknown>\n\nexport interface BlockComponents\n extends Implements<Record<BlockType, unknown>, BlockComponents> {\n paragraph: ComponentType<VisualDataBlock<ParagraphBlock>>\n header: ComponentType<VisualDataBlock<HeaderBlock>>\n quote: ComponentType<VisualDataBlock<QuoteBlock>>\n image: ComponentType<VisualDataBlock<ImageBlock>>\n raw: ComponentType<VisualDataBlock<HTMLBlock>>\n list: ComponentType<VisualDataBlock<ListBlock>>\n}\n\nexport
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/VisualContent/types.ts"],"names":[],"mappings":"","sourcesContent":["import { ComponentType } from 'react'\nimport {\n HeaderBlock,\n ImageBlock,\n ParagraphBlock,\n QuoteBlock,\n VisualData,\n VisualDataBlock,\n BlockType,\n HTMLBlock,\n ListBlock,\n} from '@starlightcms/js-sdk'\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\ntype Implements<T, U extends T> = Record<string, unknown>\n\nexport interface BlockComponents\n extends Implements<Record<BlockType, unknown>, BlockComponents> {\n paragraph: ComponentType<VisualDataBlock<ParagraphBlock>>\n header: ComponentType<VisualDataBlock<HeaderBlock>>\n quote: ComponentType<VisualDataBlock<QuoteBlock>>\n image: ComponentType<VisualDataBlock<ImageBlock>>\n raw: ComponentType<VisualDataBlock<HTMLBlock>>\n list: ComponentType<VisualDataBlock<ListBlock>>\n}\n\n/**\n * Props accepted by the {@link VisualContent} component.\n * @group VisualContent\n */\nexport interface VisualContentProps {\n /**\n * The content to render. It should be the object returned by\n * Starlight on a Visual Editor field. Required.\n */\n content?: VisualData\n /**\n * An optional object of React components. You can pass any\n * number of replacement components that will render blocks of a given type.\n */\n components?: Partial<BlockComponents>\n /**\n * If true, only a small portion of the content will be rendered,\n * and block types other than text paragraphs will be ignored. Defaults to false.\n */\n excerpt?: boolean\n /**\n * Defines the maximum number of words to render when\n * excerpt is true. Defaults to 40.\n */\n excerptLength?: number\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@starlightcms/react-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "The Starlight SDK for React",
|
|
5
|
+
"workspaces": [
|
|
6
|
+
"website"
|
|
7
|
+
],
|
|
5
8
|
"main": "dist/cjs/index.js",
|
|
6
9
|
"exports": {
|
|
7
10
|
"require": "./dist/cjs/index.js",
|
|
@@ -13,6 +16,9 @@
|
|
|
13
16
|
"build:cjs": "tsc --module commonjs --outDir dist/cjs",
|
|
14
17
|
"dev": "tsc --watch --module esnext --outDir dist/esm",
|
|
15
18
|
"dev:cjs": "tsc --watch --module commonjs --outDir dist/cjs",
|
|
19
|
+
"docs": "npm start -w website",
|
|
20
|
+
"docs:build": "npm run build -w website",
|
|
21
|
+
"docs:serve": "npm run serve -w website",
|
|
16
22
|
"prepare": "husky install",
|
|
17
23
|
"prepublishOnly": "npm run build",
|
|
18
24
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
@@ -54,7 +60,7 @@
|
|
|
54
60
|
]
|
|
55
61
|
},
|
|
56
62
|
"dependencies": {
|
|
57
|
-
"@starlightcms/js-sdk": "^0.
|
|
63
|
+
"@starlightcms/js-sdk": "^0.11.0"
|
|
58
64
|
},
|
|
59
65
|
"peerDependencies": {
|
|
60
66
|
"react": ">=16.0.0"
|