@elliemae/ds-breadcrumb 3.13.1-rc.0 → 3.13.1-rc.2

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.
@@ -0,0 +1,45 @@
1
+ import React from 'react';
2
+ import type { DSBreadcrumbPropsT } from './index.d';
3
+ declare const htmlElements: readonly ["nav", "div", "header", "footer", "main"];
4
+ declare const DSBreadcrumb: {
5
+ ({ containerProps, as, label, isTitle, children, trailingSlash, ...rest }: DSBreadcrumbPropsT): React.ReactElement;
6
+ Item: {
7
+ ({ active, as, href, isTitle, onClick, label, color, addRef, childIndex, trailingSlash, onKeyDown, ...rest }: import("./index.d").DSBreadcrumbItemPropsT): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
8
+ propTypes: {
9
+ containerComponent: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
10
+ as: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
11
+ active: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
12
+ href: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
13
+ onClick: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
14
+ isTitle: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
15
+ trailingSlash: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
16
+ label: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
17
+ color: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
18
+ };
19
+ displayName: string;
20
+ };
21
+ propTypes: {
22
+ /** props injected to breadcrumb wrapper */
23
+ containerProps: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
24
+ /**
25
+ * Type of element you want the main container to be:
26
+ * 'nav', 'div', 'header', 'footer', 'main'
27
+ */
28
+ as: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
29
+ /**
30
+ * Whether to show the last element of the breadcrumb as a title
31
+ * Also removes trailing slash to show last element as title
32
+ */
33
+ isTitle: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
34
+ /** breadcrumb label */
35
+ label: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
36
+ /**
37
+ * Container items to wrap
38
+ */
39
+ children: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
40
+ };
41
+ displayName: string;
42
+ };
43
+ declare const DSBreadcrumbWithSchema: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").DocumentedReactComponent<DSBreadcrumbPropsT>;
44
+ export { DSBreadcrumb, DSBreadcrumbWithSchema, htmlElements };
45
+ export default DSBreadcrumb;
@@ -0,0 +1,29 @@
1
+ import React from 'react';
2
+ import type { DSBreadcrumbItemPropsT } from './index.d';
3
+ declare const DSBreadcrumbItem: {
4
+ ({ active, as, href, isTitle, onClick, label, color, addRef, childIndex, trailingSlash, onKeyDown, ...rest }: DSBreadcrumbItemPropsT): React.ReactElement;
5
+ propTypes: {
6
+ /** inject props to wrapper */
7
+ containerComponent: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
8
+ /** render as any html node */
9
+ as: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
10
+ /** active item */
11
+ active: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
12
+ /** href link */
13
+ href: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
14
+ /** on click handler */
15
+ onClick: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
16
+ /** style item as title */
17
+ isTitle: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
18
+ /** add trailing slash */
19
+ trailingSlash: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
20
+ /** item label */
21
+ label: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
22
+ /** link color */
23
+ color: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").ReactDescT;
24
+ };
25
+ displayName: string;
26
+ };
27
+ declare const DSBreadcrumbItemWithSchema: import("@elliemae/ds-utilities/dist/types/props-helpers/propTypes/types").DocumentedReactComponent<DSBreadcrumbItemPropsT>;
28
+ export { DSBreadcrumbItem, DSBreadcrumbItemWithSchema };
29
+ export default DSBreadcrumbItem;
@@ -0,0 +1,2 @@
1
+ import type React from 'react';
2
+ export declare const useKeyboardNavigation: () => (((ref: HTMLAnchorElement) => void) | ((e: React.KeyboardEvent, componentRefIndex: any, callback: any) => void))[];
@@ -0,0 +1,27 @@
1
+ import type React from 'react';
2
+ import type { htmlElements } from './DSBreadcrumb';
3
+ type SafeComponentsT = typeof htmlElements[number];
4
+ type SafeItemComponentT = 'a' | 'button' | 'div' | 'span' | 'p';
5
+ interface DSBreadcrumbPropsT {
6
+ containerProps?: unknown;
7
+ as?: SafeComponentsT;
8
+ label?: string;
9
+ isTitle?: boolean;
10
+ trailingSlash?: boolean;
11
+ children: React.ReactElement[];
12
+ }
13
+ interface DSBreadcrumbItemPropsT {
14
+ active?: boolean;
15
+ isActive?: boolean;
16
+ as?: SafeItemComponentT;
17
+ href?: string;
18
+ isTitle?: boolean;
19
+ trailingSlash?: boolean;
20
+ addRef: (ref: HTMLElement) => void;
21
+ onKeyDown: (e: React.KeyboardEvent, componentRefIndex: number, onClick: () => void) => void;
22
+ onClick?: () => void;
23
+ label?: string;
24
+ childIndex: number;
25
+ color?: string | null;
26
+ }
27
+ export type { DSBreadcrumbPropsT, DSBreadcrumbItemPropsT, SafeComponentsT, SafeItemComponentT };
@@ -0,0 +1,3 @@
1
+ export * from './DSBreadcrumb';
2
+ export * from './DSBreadcrumbItem';
3
+ export { default } from './DSBreadcrumb';
@@ -0,0 +1,6 @@
1
+ import type { DSBreadcrumbItemPropsT } from './index.d';
2
+ declare const StyledList: import("styled-components").StyledComponent<keyof JSX.IntrinsicElements, import("@elliemae/ds-system").Theme, Record<string, unknown> & object, never>;
3
+ declare const StyledCrumbWrapper: import("styled-components").StyledComponent<keyof JSX.IntrinsicElements, import("@elliemae/ds-system").Theme, Record<string, unknown> & Partial<DSBreadcrumbItemPropsT>, never>;
4
+ declare const StyledContainer: import("styled-components").StyledComponent<keyof JSX.IntrinsicElements, import("@elliemae/ds-system").Theme, Record<string, unknown> & object, never>;
5
+ declare const StyledLink: import("styled-components").StyledComponent<keyof JSX.IntrinsicElements, import("@elliemae/ds-system").Theme, Record<string, unknown> & Partial<DSBreadcrumbItemPropsT>, never>;
6
+ export { StyledList, StyledCrumbWrapper, StyledContainer, StyledLink };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elliemae/ds-breadcrumb",
3
- "version": "3.13.1-rc.0",
3
+ "version": "3.13.1-rc.2",
4
4
  "license": "MIT",
5
5
  "description": "ICE MT - Dimsum - Breadcrumb",
6
6
  "files": [
@@ -51,8 +51,8 @@
51
51
  "indent": 4
52
52
  },
53
53
  "dependencies": {
54
- "@elliemae/ds-system": "3.13.1-rc.0",
55
- "@elliemae/ds-utilities": "3.13.1-rc.0"
54
+ "@elliemae/ds-system": "3.13.1-rc.2",
55
+ "@elliemae/ds-utilities": "3.13.1-rc.2"
56
56
  },
57
57
  "devDependencies": {
58
58
  "@elliemae/pui-theme": "~2.6.0",