@rokt/dcui-orchestrator 0.2.1-rc.13 → 0.2.1-rc.14

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 (9) hide show
  1. package/dist/index.cjs +23 -23
  2. package/dist/index.js +27 -27
  3. package/dist/libraries/dcui-components/src/components/data-image-carousel/carousel-indicators.d.ts +20 -0
  4. package/dist/libraries/dcui-components/src/components/data-image-carousel/data-image-carousel.d.ts +100 -0
  5. package/dist/libraries/dcui-components/src/components/data-image-carousel/factory.d.ts +2 -0
  6. package/dist/libraries/dcui-components/src/components/data-image-carousel/index.d.ts +2 -0
  7. package/dist/modules/add-to-cart/src/components/escape-hatch/factory.d.ts +1 -1
  8. package/dist/modules/add-to-cart/src/components/scroll-to-target/scroll-to-target.d.ts +56 -0
  9. package/package.json +1 -1
package/dist/libraries/dcui-components/src/components/data-image-carousel/carousel-indicators.d.ts ADDED
@@ -0,0 +1,20 @@
1
+ import { DataImageCarouselModel, CarouselActiveIndicatorMode, WhenPredicate } from '@rokt/dcui-layout-schema';
2
+ type CarouselIndicatorsProps = {
3
+ indicatorClasses?: {
4
+ progressIndicatorContainer?: string;
5
+ indicator?: string;
6
+ activeIndicator?: string;
7
+ seenIndicator?: string;
8
+ };
9
+ activeIndicatorMode?: CarouselActiveIndicatorMode | null;
10
+ activeIndicatorStyles?: NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['activeIndicator'];
11
+ activeIndex: number;
12
+ count: number;
13
+ transitionDuration?: number;
14
+ testId?: string;
15
+ };
16
+ export declare const defaultIndicatorContainerStyles: NonNullable<NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['progressIndicatorContainer']>;
17
+ export declare const defaultIndicatorStyles: NonNullable<NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['indicator']>;
18
+ export declare const defaultActiveIndicatorStyles: NonNullable<NonNullable<NonNullable<DataImageCarouselModel<WhenPredicate>['styles']>['elements']>['activeIndicator']>;
19
+ export declare function CarouselIndicators(props: CarouselIndicatorsProps): import("react/jsx-runtime").JSX.Element;
20
+ export {};
package/dist/libraries/dcui-components/src/components/data-image-carousel/data-image-carousel.d.ts ADDED
@@ -0,0 +1,100 @@
1
+ import { DataImageCarouselModel, WhenPredicate } from '@rokt/dcui-layout-schema';
2
+ export interface DataImageCarouselProps {
3
+ /**
4
+ * - `imageKey`: the key prefix for the image objects of the creative images contexts.
5
+ * - `indicators`:
6
+ * * `show`: boolean
7
+ * * `activeIndicatorMode`: 'Progress' | 'Seen'
8
+ * - `duration`: number - Time in milliseconds before changing to the next image.
9
+ * - `transition`:
10
+ * * `type`: 'SlideInOut' | 'FadeInOut' - Transition type.
11
+ * * `settings`:
12
+ * * `speed`: 'fast' | 'medium' | 'slow' - Speed of the transition.
13
+ * - `a11yLabel`: string
14
+ * - `styles`:
15
+ * * `elements`:
16
+ * * `own`:
17
+ * - `container`
18
+ * - `background`
19
+ * - `border`
20
+ * - `dimension`
21
+ * - `flexChild`
22
+ * - `spacing`
23
+ * * `progressIndicatorContainer`:
24
+ * - `container`
25
+ * - `background`
26
+ * - `border`
27
+ * - `dimension`
28
+ * - `flexChild`
29
+ * - `spacing`
30
+ * * `indicator`:
31
+ * - `container`
32
+ * - `background`
33
+ * - `border`
34
+ * - `dimension`
35
+ * - `flexChild`
36
+ * - `spacing`
37
+ * * `seenIndicator`:
38
+ * - `container`
39
+ * - `background`
40
+ * - `border`
41
+ * - `dimension`
42
+ * - `flexChild`
43
+ * - `spacing`
44
+ * * `activeIndicator`:
45
+ * - `container`
46
+ * - `background`
47
+ * - `border`
48
+ * - `dimension`
49
+ * - `flexChild`
50
+ * - `spacing`
51
+ * * `transitions`:
52
+ * - `type`: 'Conditional'
53
+ * - `transition`:
54
+ * * `predicates`: WhenPredicate[]
55
+ * * `duration`: number
56
+ * * `value`:
57
+ * * `own`:
58
+ * - `container`
59
+ * - `background`
60
+ * - `border`
61
+ * - `dimension`
62
+ * - `flexChild`
63
+ * - `spacing`
64
+ * * `progressIndicatorContainer`:
65
+ * - `container`
66
+ * - `background`
67
+ * - `border`
68
+ * - `dimension`
69
+ * - `flexChild`
70
+ * - `spacing`
71
+ * * `indicator`:
72
+ * - `container`
73
+ * - `background`
74
+ * - `border`
75
+ * - `dimension`
76
+ * - `flexChild`
77
+ * - `spacing`
78
+ * * `seenIndicator`:
79
+ * - `container`
80
+ * - `background`
81
+ * - `border`
82
+ * - `dimension`
83
+ * - `flexChild`
84
+ * - `spacing`
85
+ * * `activeIndicator`:
86
+ * - `container`
87
+ * - `background`
88
+ * - `border`
89
+ * - `dimension`
90
+ * - `flexChild`
91
+ * - `spacing`
92
+ */
93
+ schema: DataImageCarouselModel<WhenPredicate>;
94
+ testId?: string;
95
+ }
96
+ /** The DataImageCarousel is an image node that displays all images prefixed with the given key in the creative images contexts. <br>
97
+ * It supports various formats and sizes.<br>
98
+ * *Where can we use this: __layout variant__*
99
+ * */
100
+ export declare function DataImageCarousel(props: DataImageCarouselProps): import("react/jsx-runtime").JSX.Element | null;
package/dist/libraries/dcui-components/src/components/data-image-carousel/factory.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { LayoutSchemaModel } from '@rokt/dcui-layout-schema';
2
+ export declare function tryMakeDataImageCarousel(schema: LayoutSchemaModel, testId?: string): JSX.Element | void;
package/dist/libraries/dcui-components/src/components/data-image-carousel/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export * from './data-image-carousel';
2
+ export * from './factory';
package/dist/modules/add-to-cart/src/components/escape-hatch/factory.d.ts CHANGED
@@ -1,2 +1,2 @@
1
1
  import { LayoutSchemaModel } from '@rokt/dcui-layout-schema';
2
- export declare function tryMakeEscapeHatch(schema: LayoutSchemaModel): JSX.Element | undefined;
2
+ export declare function tryMakeEscapeHatch(schema: LayoutSchemaModel, testId?: string): JSX.Element | undefined;
package/dist/modules/add-to-cart/src/components/scroll-to-target/scroll-to-target.d.ts ADDED
@@ -0,0 +1,56 @@
1
+ import { LayoutStyle, BasicStateStylingBlock, BasicTextStyle } from '@rokt/dcui-layout-schema';
2
+ export interface ScrollToTargetElements {
3
+ own: BasicStateStylingBlock<BasicTextStyle>[];
4
+ text: BasicStateStylingBlock<BasicTextStyle>[];
5
+ highlighted: BasicStateStylingBlock<BasicTextStyle>[];
6
+ }
7
+ export interface ScrollToTargetTarget {
8
+ key: string;
9
+ value: string;
10
+ }
11
+ export interface ScrollToTargetModel {
12
+ target: ScrollToTargetTarget;
13
+ text: string;
14
+ highlightedText: string;
15
+ styles?: null | LayoutStyle<ScrollToTargetElements, never>;
16
+ a11yLabel?: string;
17
+ }
18
+ export interface ScrollToTargetProps {
19
+ /**
20
+ * - `target`: object with key and value to identify the target element
21
+ * - `key`: the attribute name (e.g., 'aria-label', 'data-testid', 'id')
22
+ * - `value`: the attribute value to search for
23
+ * - `text`: the full text content (supports data mapping)
24
+ * - `highlightedText`: the portion of text that should be highlighted and clickable (supports data mapping)
25
+ * - `styles`:
26
+ * * `elements`:
27
+ * - `own`: styles for container
28
+ * * `dimension`
29
+ * * `flexChild`
30
+ * * `spacing`
31
+ * * `background`
32
+ * * `text`
33
+ * - `highlighted`: styles for highlighted (clickable) text
34
+ * * `dimension`
35
+ * * `flexChild`
36
+ * * `spacing`
37
+ * * `background`
38
+ * * `text`
39
+ * - `text`: styles for regular (non-highlighted) text
40
+ * * `dimension`
41
+ * * `flexChild`
42
+ * * `spacing`
43
+ * * `background`
44
+ * * `text`
45
+ * - `a11yLabel`: optional accessibility label for screen readers
46
+ */
47
+ schema: ScrollToTargetModel;
48
+ testId?: string;
49
+ }
50
+ /**
51
+ * The ScrollToTarget is a specialized text component that displays text with a highlighted portion.
52
+ * Only the highlighted text is clickable and triggers smooth scrolling to a target element.
53
+ * The component supports separate styling for regular text and highlighted text portions.
54
+ * Target elements are identified by a configurable attribute key-value pair.
55
+ */
56
+ export declare function ScrollToTarget({ schema, testId }: ScrollToTargetProps): import("react/jsx-runtime").JSX.Element;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rokt/dcui-orchestrator",
3
- "version": "0.2.1-rc.13",
3
+ "version": "0.2.1-rc.14",
4
4
  "description": "Rokt's DCUI rendering process",
5
5
  "main": "dist/index.cjs",
6
6
  "module": "dist/index.js",