@contentful/experiences-components-react 1.39.0-alpha-20250528T1201-58ca01e.0 → 1.39.0-alpha-20250528T1549-bd210e1.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/dist/index.d.ts +30 -85
- package/dist/index.js +152 -188
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import { ComponentDefinition, OptimizedImageAsset,
|
|
2
|
-
import React
|
|
1
|
+
import { ComponentDefinition, OptimizedImageAsset, StructureComponentProps, StyleProps } from '@contentful/experiences-core/types';
|
|
2
|
+
import React, { HTMLAttributes } from 'react';
|
|
3
3
|
import { Document } from '@contentful/rich-text-types';
|
|
4
|
-
import { EntityStore } from '@contentful/experiences-core';
|
|
5
4
|
|
|
6
|
-
interface ButtonProps extends React
|
|
5
|
+
interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
|
|
7
6
|
/**
|
|
8
7
|
* The URL to navigate to when the button is clicked. When provided, the button will be wrapped in an anchor tag.
|
|
9
8
|
* @default undefined
|
|
@@ -60,13 +59,13 @@ interface ButtonProps extends React$1.ButtonHTMLAttributes<HTMLButtonElement> {
|
|
|
60
59
|
* <Button>Go</Button>
|
|
61
60
|
* ```
|
|
62
61
|
*/
|
|
63
|
-
children?: React
|
|
62
|
+
children?: React.ReactNode;
|
|
64
63
|
}
|
|
65
|
-
declare const Button: React
|
|
64
|
+
declare const Button: React.FC<ButtonProps>;
|
|
66
65
|
|
|
67
66
|
declare const ButtonComponentDefinition: ComponentDefinition;
|
|
68
67
|
|
|
69
|
-
interface HeadingProps extends React
|
|
68
|
+
interface HeadingProps extends React.HTMLAttributes<HTMLHeadingElement> {
|
|
70
69
|
/**
|
|
71
70
|
* The text to display in the heading. If not provided, children will be used instead.
|
|
72
71
|
* @default undefined
|
|
@@ -86,7 +85,7 @@ interface HeadingProps extends React$1.HTMLAttributes<HTMLHeadingElement> {
|
|
|
86
85
|
* <Heading>My Heading</Heading>
|
|
87
86
|
* ```
|
|
88
87
|
*/
|
|
89
|
-
children?: React
|
|
88
|
+
children?: React.ReactNode;
|
|
90
89
|
/**
|
|
91
90
|
* The type of heading to render
|
|
92
91
|
* @default h1
|
|
@@ -98,11 +97,11 @@ interface HeadingProps extends React$1.HTMLAttributes<HTMLHeadingElement> {
|
|
|
98
97
|
*/
|
|
99
98
|
type?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
|
|
100
99
|
}
|
|
101
|
-
declare const Heading: React
|
|
100
|
+
declare const Heading: React.FC<HeadingProps>;
|
|
102
101
|
|
|
103
102
|
declare const HeadingComponentDefinition: ComponentDefinition;
|
|
104
103
|
|
|
105
|
-
interface RichTextProps extends Omit<React
|
|
104
|
+
interface RichTextProps extends Omit<React.HTMLAttributes<HTMLElement>, 'value'> {
|
|
106
105
|
/**
|
|
107
106
|
* Renders the text in a specific HTML tag.
|
|
108
107
|
* @default p
|
|
@@ -132,11 +131,11 @@ interface RichTextProps extends Omit<React$1.HTMLAttributes<HTMLElement>, 'value
|
|
|
132
131
|
*/
|
|
133
132
|
value: Document;
|
|
134
133
|
}
|
|
135
|
-
declare const RichText: React
|
|
134
|
+
declare const RichText: React.FC<RichTextProps>;
|
|
136
135
|
|
|
137
136
|
declare const RichTextComponentDefinition: ComponentDefinition;
|
|
138
137
|
|
|
139
|
-
interface TextProps extends React
|
|
138
|
+
interface TextProps extends React.HTMLAttributes<HTMLElement> {
|
|
140
139
|
/**
|
|
141
140
|
* The URL to navigate to when the text is clicked. When provided, the text will be wrapped in an anchor tag.
|
|
142
141
|
* @default undefined
|
|
@@ -194,7 +193,7 @@ interface TextProps extends React$1.HTMLAttributes<HTMLElement> {
|
|
|
194
193
|
* <Text>My Text</Text>
|
|
195
194
|
* ```
|
|
196
195
|
*/
|
|
197
|
-
children?: React
|
|
196
|
+
children?: React.ReactNode;
|
|
198
197
|
/**
|
|
199
198
|
* Renders the text in a specific HTML tag.
|
|
200
199
|
* @default p
|
|
@@ -206,38 +205,24 @@ interface TextProps extends React$1.HTMLAttributes<HTMLElement> {
|
|
|
206
205
|
*/
|
|
207
206
|
as?: 'p' | 'span' | 'div' | 'label' | 'caption' | 'small' | 'strong' | 'em';
|
|
208
207
|
}
|
|
209
|
-
declare const Text: React
|
|
208
|
+
declare const Text: React.FC<TextProps>;
|
|
210
209
|
|
|
211
210
|
declare const TextComponentDefinition: ComponentDefinition;
|
|
212
211
|
|
|
213
|
-
interface ImageProps extends React
|
|
212
|
+
interface ImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
|
|
214
213
|
cfImageAsset?: OptimizedImageAsset | string;
|
|
215
214
|
}
|
|
216
|
-
declare const Image: React
|
|
215
|
+
declare const Image: React.FC<ImageProps>;
|
|
217
216
|
|
|
218
217
|
declare const ImageComponentDefinition: ComponentDefinition;
|
|
219
218
|
|
|
220
|
-
type ContentfulContainerAsHyperlinkProps
|
|
221
|
-
editorMode?: EditorMode;
|
|
222
|
-
node: ExperienceTreeNode;
|
|
223
|
-
dataSource?: ExperienceDataSource;
|
|
224
|
-
unboundValues?: ExperienceUnboundValues;
|
|
225
|
-
resolveDesignValue?: any;
|
|
226
|
-
entityStore?: RefObject<EntityStore>;
|
|
227
|
-
areEntitiesFetched?: boolean;
|
|
228
|
-
renderDropzone: (node: ExperienceTreeNode, props?: Record<string, any>) => React$1.ReactNode;
|
|
229
|
-
} : {
|
|
230
|
-
editorMode: EditorMode;
|
|
231
|
-
}) & {
|
|
232
|
-
children?: React$1.ReactNode;
|
|
219
|
+
type ContentfulContainerAsHyperlinkProps = StructureComponentProps<{
|
|
233
220
|
className?: string;
|
|
234
221
|
cfHyperlink?: StyleProps['cfHyperlink'];
|
|
235
222
|
cfOpenInNewTab?: StyleProps['cfOpenInNewTab'];
|
|
236
|
-
|
|
237
|
-
dragProps?: DragWrapperProps;
|
|
238
|
-
};
|
|
223
|
+
}>;
|
|
239
224
|
|
|
240
|
-
declare const ContentfulContainer: React
|
|
225
|
+
declare const ContentfulContainer: React.FC<ContentfulContainerAsHyperlinkProps>;
|
|
241
226
|
|
|
242
227
|
declare const containerDefinition: ComponentDefinition;
|
|
243
228
|
declare const sectionDefinition: ComponentDefinition;
|
|
@@ -246,71 +231,31 @@ type ContentfulDividerProps = {
|
|
|
246
231
|
className?: string;
|
|
247
232
|
dragProps?: unknown;
|
|
248
233
|
};
|
|
249
|
-
declare const ContentfulDivider: ({ className, dragProps: _, ...props }: ContentfulDividerProps) => React
|
|
234
|
+
declare const ContentfulDivider: ({ className, dragProps: _, ...props }: ContentfulDividerProps) => React.JSX.Element;
|
|
250
235
|
|
|
251
236
|
declare const dividerDefinition: ComponentDefinition;
|
|
252
237
|
|
|
253
|
-
|
|
254
|
-
editorMode: boolean;
|
|
238
|
+
type ColumnsProps = StructureComponentProps<{
|
|
255
239
|
className?: string;
|
|
256
|
-
|
|
257
|
-
}
|
|
258
|
-
interface ColumnsEditorModeProps extends ColumnsBaseProps {
|
|
259
|
-
editorMode: true;
|
|
260
|
-
cfColumns: string;
|
|
261
|
-
node: ExperienceTreeNode;
|
|
262
|
-
renderDropzone: (node: ExperienceTreeNode, props?: Record<string, unknown>) => React.ReactNode;
|
|
263
|
-
dragProps?: unknown;
|
|
264
|
-
}
|
|
265
|
-
interface ColumnsDeliveryModeProps extends ColumnsBaseProps {
|
|
266
|
-
editorMode: false;
|
|
267
|
-
}
|
|
268
|
-
interface SingleColumnEditorModeProps extends ColumnsBaseProps {
|
|
269
|
-
editorMode: true;
|
|
270
|
-
node: ExperienceTreeNode;
|
|
271
|
-
renderDropzone: (node: ExperienceTreeNode, props?: Record<string, unknown>) => React.ReactNode;
|
|
272
|
-
cfColumnSpan: string;
|
|
273
|
-
dragProps?: unknown;
|
|
274
|
-
['data-ctfl-draggable-id']: string;
|
|
275
|
-
style?: CSSProperties;
|
|
276
|
-
className: string;
|
|
277
|
-
onMouseOver: (e: SyntheticEvent<Element, Event>) => void;
|
|
278
|
-
onMouseOut: (e: SyntheticEvent<Element, Event>) => void;
|
|
279
|
-
onMouseDown: (e: SyntheticEvent<Element, Event>) => void;
|
|
280
|
-
onMouseUp: (e: SyntheticEvent<Element, Event>) => void;
|
|
281
|
-
onClick: (e: SyntheticEvent<Element, Event>) => void;
|
|
282
|
-
}
|
|
283
|
-
interface SingleColumnDeliveryModeProps extends ColumnsBaseProps {
|
|
284
|
-
editorMode: false;
|
|
285
|
-
}
|
|
286
|
-
type ColumnsProps = ColumnsEditorModeProps | ColumnsDeliveryModeProps;
|
|
287
|
-
type SingleColumnProps = SingleColumnEditorModeProps | SingleColumnDeliveryModeProps;
|
|
240
|
+
}>;
|
|
241
|
+
declare const Columns: ({ className, children, ...otherProps }: ColumnsProps) => React.JSX.Element;
|
|
288
242
|
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
243
|
+
type SingleColumnProps = StructureComponentProps<{
|
|
244
|
+
className?: string;
|
|
245
|
+
}>;
|
|
246
|
+
declare const SingleColumn: React.FC<SingleColumnProps>;
|
|
292
247
|
|
|
293
248
|
declare const columnsDefinition: ComponentDefinition;
|
|
294
249
|
declare const singleColumnDefinition: ComponentDefinition;
|
|
295
250
|
|
|
296
|
-
type AssemblyProps
|
|
297
|
-
|
|
298
|
-
className?: string;
|
|
299
|
-
cfHyperlink?: StyleProps['cfHyperlink'];
|
|
300
|
-
cfOpenInNewTab?: StyleProps['cfOpenInNewTab'];
|
|
301
|
-
editorMode?: EditorMode;
|
|
302
|
-
node: ExperienceTreeNode;
|
|
303
|
-
resolveDesignValue?: ResolveDesignValueType;
|
|
304
|
-
dragProps?: Record<string, any>;
|
|
305
|
-
renderDropzone: (node: ExperienceTreeNode, props?: Record<string, any>) => React$1.ReactNode;
|
|
306
|
-
} : Record<string, any>;
|
|
307
|
-
declare const Assembly: React$1.FC<AssemblyProps>;
|
|
251
|
+
type AssemblyProps = StructureComponentProps<HTMLAttributes<HTMLDivElement>>;
|
|
252
|
+
declare const Assembly: React.FC<AssemblyProps>;
|
|
308
253
|
|
|
309
254
|
interface CarouselProps {
|
|
310
255
|
className?: string;
|
|
311
|
-
children?: React
|
|
256
|
+
children?: React.ReactNode;
|
|
312
257
|
}
|
|
313
|
-
declare const Carousel: React
|
|
258
|
+
declare const Carousel: React.FC<CarouselProps>;
|
|
314
259
|
|
|
315
260
|
declare const carouselDefinition: ComponentDefinition;
|
|
316
261
|
|