@instructure/ui-breadcrumb 8.14.1-snapshot.7 → 8.14.1-snapshot.70

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 (28) hide show
  1. package/es/Breadcrumb/BreadcrumbLink/BreadcrumbLinkLocator.js +2 -1
  2. package/es/Breadcrumb/BreadcrumbLink/index.js +2 -3
  3. package/es/Breadcrumb/BreadcrumbLink/props.js +0 -23
  4. package/es/Breadcrumb/BreadcrumbLocator.js +2 -1
  5. package/es/Breadcrumb/index.js +13 -8
  6. package/es/Breadcrumb/props.js +0 -17
  7. package/lib/Breadcrumb/BreadcrumbLink/BreadcrumbLinkLocator.js +1 -0
  8. package/lib/Breadcrumb/BreadcrumbLink/index.js +2 -3
  9. package/lib/Breadcrumb/BreadcrumbLink/props.js +0 -23
  10. package/lib/Breadcrumb/BreadcrumbLocator.js +1 -0
  11. package/lib/Breadcrumb/index.js +16 -9
  12. package/lib/Breadcrumb/props.js +0 -17
  13. package/package.json +16 -16
  14. package/src/Breadcrumb/BreadcrumbLink/index.tsx +1 -2
  15. package/src/Breadcrumb/BreadcrumbLink/props.ts +25 -21
  16. package/src/Breadcrumb/index.tsx +6 -10
  17. package/src/Breadcrumb/props.ts +14 -14
  18. package/tsconfig.build.tsbuildinfo +1 -1
  19. package/types/Breadcrumb/BreadcrumbLink/BreadcrumbLinkLocator.d.ts +4 -4
  20. package/types/Breadcrumb/BreadcrumbLink/index.d.ts +5 -4
  21. package/types/Breadcrumb/BreadcrumbLink/index.d.ts.map +1 -1
  22. package/types/Breadcrumb/BreadcrumbLink/props.d.ts +24 -3
  23. package/types/Breadcrumb/BreadcrumbLink/props.d.ts.map +1 -1
  24. package/types/Breadcrumb/BreadcrumbLocator.d.ts +14 -14
  25. package/types/Breadcrumb/index.d.ts +2 -1
  26. package/types/Breadcrumb/index.d.ts.map +1 -1
  27. package/types/Breadcrumb/props.d.ts +14 -0
  28. package/types/Breadcrumb/props.d.ts.map +1 -1
package/types/Breadcrumb/BreadcrumbLink/BreadcrumbLinkLocator.d.ts CHANGED
@@ -36,7 +36,7 @@ export declare const BreadcrumbLinkLocator: {
36
36
  debug: (maxLength?: number | undefined, options?: {
37
37
  highlight: boolean;
38
38
  } | undefined) => void;
39
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
39
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
40
40
  getTextContent: () => string | null;
41
41
  getParentNode: () => ParentNode | null;
42
42
  parent: () => ParentNode | null;
@@ -175,7 +175,7 @@ export declare const BreadcrumbLinkLocator: {
175
175
  debug: (maxLength?: number | undefined, options?: {
176
176
  highlight: boolean;
177
177
  } | undefined) => void;
178
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
178
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
179
179
  getTextContent: () => string | null;
180
180
  getParentNode: () => ParentNode | null;
181
181
  parent: () => ParentNode | null;
@@ -314,7 +314,7 @@ export declare const BreadcrumbLinkLocator: {
314
314
  debug: (maxLength?: number | undefined, options?: {
315
315
  highlight: boolean;
316
316
  } | undefined) => void;
317
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
317
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
318
318
  getTextContent: () => string | null;
319
319
  getParentNode: () => ParentNode | null;
320
320
  parent: () => ParentNode | null;
@@ -453,7 +453,7 @@ export declare const BreadcrumbLinkLocator: {
453
453
  debug: (maxLength?: number | undefined, options?: {
454
454
  highlight: boolean;
455
455
  } | undefined) => void;
456
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
456
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
457
457
  getTextContent: () => string | null;
458
458
  getParentNode: () => ParentNode | null;
459
459
  parent: () => ParentNode | null;
package/types/Breadcrumb/BreadcrumbLink/index.d.ts CHANGED
@@ -5,23 +5,24 @@ import type { BreadcrumbLinkProps } from './props';
5
5
  parent: Breadcrumb
6
6
  id: Breadcrumb.Link
7
7
  ---
8
+ @tsProps
8
9
  **/
9
10
  declare class BreadcrumbLink extends Component<BreadcrumbLinkProps> {
10
11
  static readonly componentId = "Breadcrumb.Link";
11
12
  static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
12
13
  children: React.ReactNode;
13
14
  href?: string | undefined;
14
- onClick?: ((...args: any[]) => any) | undefined;
15
+ onClick?: ((event: React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewOwnProps, MouseEvent>) => void) | undefined;
15
16
  size?: "small" | "medium" | "large" | undefined;
16
- renderIcon?: React.ReactNode | ((...args: any[]) => any);
17
+ renderIcon?: React.ReactNode | (() => React.ReactNode);
17
18
  iconPlacement?: "start" | "end" | undefined;
18
19
  }>;
19
20
  static allowedProps: readonly (keyof {
20
21
  children: React.ReactNode;
21
22
  href?: string | undefined;
22
- onClick?: ((...args: any[]) => any) | undefined;
23
+ onClick?: ((event: React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewOwnProps, MouseEvent>) => void) | undefined;
23
24
  size?: "small" | "medium" | "large" | undefined;
24
- renderIcon?: React.ReactNode | ((...args: any[]) => any);
25
+ renderIcon?: React.ReactNode | (() => React.ReactNode);
25
26
  iconPlacement?: "start" | "end" | undefined;
26
27
  })[];
27
28
  static defaultProps: {};
package/types/Breadcrumb/BreadcrumbLink/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Breadcrumb/BreadcrumbLink/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAQxC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;GAKG;AAEH,cACM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,SAAS;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY,KAAK;IAExB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,MAAM;CAqBP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Breadcrumb/BreadcrumbLink/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAQxC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;;GAMG;AAEH,cACM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,SAAS;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY,KAAK;IAExB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,MAAM;CAmBP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
package/types/Breadcrumb/BreadcrumbLink/props.d.ts CHANGED
@@ -1,16 +1,37 @@
1
1
  import React from 'react';
2
2
  import type { OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
3
+ import type { ViewOwnProps } from '@instructure/ui-view';
3
4
  declare type BreadcrumbLinkOwnProps = {
5
+ /**
6
+ * Content to render as the crumb, generally should be text.
7
+ */
4
8
  children: React.ReactNode;
9
+ /**
10
+ * Link the crumb should direct to; if an href is provided, the crumb will render as a link
11
+ */
5
12
  href?: string;
6
- onClick?: (...args: any[]) => any;
13
+ /**
14
+ * If the Breadcrumb.Link has an onClick prop (and no href), it will render as a button
15
+ */
16
+ onClick?: (event: React.MouseEvent<ViewOwnProps, MouseEvent>) => void;
17
+ /**
18
+ * Sets the font-size of the breadcrumb text
19
+ */
7
20
  size?: 'small' | 'medium' | 'large';
8
- renderIcon?: React.ReactNode | ((...args: any[]) => any);
21
+ /**
22
+ * Add an icon to the Breadcrumb.Link
23
+ */
24
+ renderIcon?: React.ReactNode | (() => React.ReactNode);
25
+ /**
26
+ * Place the icon before or after the text in the Breadcrumb.Link
27
+ */
9
28
  iconPlacement?: 'start' | 'end';
10
29
  };
11
30
  declare type PropKeys = keyof BreadcrumbLinkOwnProps;
12
31
  declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
13
- declare type BreadcrumbLinkProps = BreadcrumbLinkOwnProps & OtherHTMLAttributes<BreadcrumbLinkOwnProps>;
32
+ declare type BreadcrumbLinkProps = BreadcrumbLinkOwnProps & OtherHTMLAttributes<BreadcrumbLinkOwnProps> & {
33
+ to?: string;
34
+ };
14
35
  declare const propTypes: PropValidators<PropKeys>;
15
36
  declare const allowedProps: AllowedPropKeys;
16
37
  export type { BreadcrumbLinkProps };
package/types/Breadcrumb/BreadcrumbLink/props.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Breadcrumb/BreadcrumbLink/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,aAAK,sBAAsB,GAAG;IAC5B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACxD,aAAa,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;CAChC,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,sBAAsB,CAAA;AAE5C,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,mBAAmB,GAAG,sBAAsB,GAC/C,mBAAmB,CAAC,sBAAsB,CAAC,CAAA;AAE7C,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAyBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAOnB,CAAA;AAED,YAAY,EAAE,mBAAmB,EAAE,CAAA;AACnC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
1
+ {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Breadcrumb/BreadcrumbLink/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAExD,aAAK,sBAAsB,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,KAAK,IAAI,CAAA;IACrE;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACtD;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;CAChC,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,sBAAsB,CAAA;AAE5C,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,mBAAmB,GAAG,sBAAsB,GAC/C,mBAAmB,CAAC,sBAAsB,CAAC,GAAG;IAE5C,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AAEH,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAOvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAOnB,CAAA;AAED,YAAY,EAAE,mBAAmB,EAAE,CAAA;AACnC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
package/types/Breadcrumb/BreadcrumbLocator.d.ts CHANGED
@@ -32,7 +32,7 @@ export declare const BreadcrumbLocator: {
32
32
  debug: (maxLength?: number | undefined, options?: {
33
33
  highlight: boolean;
34
34
  } | undefined) => void;
35
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
35
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
36
36
  getTextContent: () => string | null;
37
37
  getParentNode: () => ParentNode | null;
38
38
  parent: () => ParentNode | null;
@@ -171,7 +171,7 @@ export declare const BreadcrumbLocator: {
171
171
  debug: (maxLength?: number | undefined, options?: {
172
172
  highlight: boolean;
173
173
  } | undefined) => void;
174
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
174
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
175
175
  getTextContent: () => string | null;
176
176
  getParentNode: () => ParentNode | null;
177
177
  parent: () => ParentNode | null;
@@ -317,7 +317,7 @@ export declare const BreadcrumbLocator: {
317
317
  debug: (maxLength?: number | undefined, options?: {
318
318
  highlight: boolean;
319
319
  } | undefined) => void;
320
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
320
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
321
321
  getTextContent: () => string | null;
322
322
  getParentNode: () => ParentNode | null;
323
323
  parent: () => ParentNode | null;
@@ -456,7 +456,7 @@ export declare const BreadcrumbLocator: {
456
456
  debug: (maxLength?: number | undefined, options?: {
457
457
  highlight: boolean;
458
458
  } | undefined) => void;
459
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
459
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
460
460
  getTextContent: () => string | null;
461
461
  getParentNode: () => ParentNode | null;
462
462
  parent: () => ParentNode | null;
@@ -595,7 +595,7 @@ export declare const BreadcrumbLocator: {
595
595
  debug: (maxLength?: number | undefined, options?: {
596
596
  highlight: boolean;
597
597
  } | undefined) => void;
598
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
598
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
599
599
  getTextContent: () => string | null;
600
600
  getParentNode: () => ParentNode | null;
601
601
  parent: () => ParentNode | null;
@@ -735,7 +735,7 @@ export declare const BreadcrumbLocator: {
735
735
  debug: (maxLength?: number | undefined, options?: {
736
736
  highlight: boolean;
737
737
  } | undefined) => void;
738
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
738
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
739
739
  getTextContent: () => string | null;
740
740
  getParentNode: () => ParentNode | null;
741
741
  parent: () => ParentNode | null;
@@ -874,7 +874,7 @@ export declare const BreadcrumbLocator: {
874
874
  debug: (maxLength?: number | undefined, options?: {
875
875
  highlight: boolean;
876
876
  } | undefined) => void;
877
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
877
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
878
878
  getTextContent: () => string | null;
879
879
  getParentNode: () => ParentNode | null;
880
880
  parent: () => ParentNode | null;
@@ -1013,7 +1013,7 @@ export declare const BreadcrumbLocator: {
1013
1013
  debug: (maxLength?: number | undefined, options?: {
1014
1014
  highlight: boolean;
1015
1015
  } | undefined) => void;
1016
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
1016
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
1017
1017
  getTextContent: () => string | null;
1018
1018
  getParentNode: () => ParentNode | null;
1019
1019
  parent: () => ParentNode | null;
@@ -1153,7 +1153,7 @@ export declare const BreadcrumbLocator: {
1153
1153
  debug: (maxLength?: number | undefined, options?: {
1154
1154
  highlight: boolean;
1155
1155
  } | undefined) => void;
1156
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
1156
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
1157
1157
  getTextContent: () => string | null;
1158
1158
  getParentNode: () => ParentNode | null;
1159
1159
  parent: () => ParentNode | null;
@@ -1292,7 +1292,7 @@ export declare const BreadcrumbLocator: {
1292
1292
  debug: (maxLength?: number | undefined, options?: {
1293
1293
  highlight: boolean;
1294
1294
  } | undefined) => void;
1295
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
1295
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
1296
1296
  getTextContent: () => string | null;
1297
1297
  getParentNode: () => ParentNode | null;
1298
1298
  parent: () => ParentNode | null;
@@ -1431,7 +1431,7 @@ export declare const BreadcrumbLocator: {
1431
1431
  debug: (maxLength?: number | undefined, options?: {
1432
1432
  highlight: boolean;
1433
1433
  } | undefined) => void;
1434
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
1434
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
1435
1435
  getTextContent: () => string | null;
1436
1436
  getParentNode: () => ParentNode | null;
1437
1437
  parent: () => ParentNode | null;
@@ -1571,7 +1571,7 @@ export declare const BreadcrumbLocator: {
1571
1571
  debug: (maxLength?: number | undefined, options?: {
1572
1572
  highlight: boolean;
1573
1573
  } | undefined) => void;
1574
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
1574
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
1575
1575
  getTextContent: () => string | null;
1576
1576
  getParentNode: () => ParentNode | null;
1577
1577
  parent: () => ParentNode | null;
@@ -1710,7 +1710,7 @@ export declare const BreadcrumbLocator: {
1710
1710
  debug: (maxLength?: number | undefined, options?: {
1711
1711
  highlight: boolean;
1712
1712
  } | undefined) => void;
1713
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
1713
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
1714
1714
  getTextContent: () => string | null;
1715
1715
  getParentNode: () => ParentNode | null;
1716
1716
  parent: () => ParentNode | null;
@@ -1849,7 +1849,7 @@ export declare const BreadcrumbLocator: {
1849
1849
  debug: (maxLength?: number | undefined, options?: {
1850
1850
  highlight: boolean;
1851
1851
  } | undefined) => void;
1852
- accessible: (options?: Record<string, unknown> | undefined) => Promise<boolean>;
1852
+ accessible: (options?: Record<string, unknown> | undefined) => Promise<true | Error>;
1853
1853
  getTextContent: () => string | null;
1854
1854
  getParentNode: () => ParentNode | null;
1855
1855
  parent: () => ParentNode | null;
package/types/Breadcrumb/index.d.ts CHANGED
@@ -7,6 +7,7 @@ import type { BreadcrumbProps } from './props';
7
7
  ---
8
8
  category: components
9
9
  ---
10
+ @tsProps
10
11
  **/
11
12
  declare class Breadcrumb extends Component<BreadcrumbProps> {
12
13
  static readonly componentId = "Breadcrumb";
@@ -29,7 +30,7 @@ declare class Breadcrumb extends Component<BreadcrumbProps> {
29
30
  ref: Element | null;
30
31
  handleRef: (el: Element | null) => void;
31
32
  componentDidMount(): void;
32
- componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
33
+ componentDidUpdate(): void;
33
34
  static Link: typeof BreadcrumbLink;
34
35
  renderChildren(): jsx.JSX.Element[] | null | undefined;
35
36
  render(): jsx.JSX.Element;
package/types/Breadcrumb/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Breadcrumb/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMxC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAMjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9C;;;;GAIG;AAEH,cAEM,UAAW,SAAQ,SAAS,CAAC,eAAe,CAAC;IACjD,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,SAAS;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;MAGlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAMjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAKjD,MAAM,CAAC,IAAI,wBAAiB;IAE5B,cAAc;IAmBd,MAAM;CAeP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Breadcrumb/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAKxC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAMjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9C;;;;;GAKG;AAEH,cAEM,UAAW,SAAQ,SAAS,CAAC,eAAe,CAAC;IACjD,MAAM,CAAC,QAAQ,CAAC,WAAW,gBAAe;IAE1C,MAAM,CAAC,SAAS;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;MAGlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAGjB,kBAAkB;IAIlB,MAAM,CAAC,IAAI,wBAAiB;IAE5B,cAAc;IAkBd,MAAM;CAeP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAA"}
package/types/Breadcrumb/props.d.ts CHANGED
@@ -2,9 +2,23 @@
2
2
  import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
3
3
  import type { BreadcrumbTheme, PropValidators } from '@instructure/shared-types';
4
4
  declare type BreadcrumbOwnProps = {
5
+ /**
6
+ * children of type Breadcrumb.Link
7
+ */
5
8
  children?: React.ReactNode;
9
+ /**
10
+ * An accessible label for the navigation
11
+ */
6
12
  label: string;
13
+ /**
14
+ * Sets the font-size of the breadcrumb text
15
+ */
7
16
  size?: 'small' | 'medium' | 'large';
17
+ /**
18
+ * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
19
+ * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
20
+ * familiar CSS-like shorthand. For example: `margin="small auto large"`.
21
+ */
8
22
  margin?: Spacing;
9
23
  };
10
24
  declare type PropKeys = keyof BreadcrumbOwnProps;
package/types/Breadcrumb/props.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Breadcrumb/props.ts"],"names":[],"mappings":";AA+BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAEhF,aAAK,kBAAkB,GAAG;IACxB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,eAAe,GAAG,kBAAkB,GACvC,cAAc,CAAC,eAAe,EAAE,eAAe,CAAC,CAAA;AAElD,aAAK,eAAe,GAAG,cAAc,CAAC,YAAY,GAAG,OAAO,GAAG,WAAW,CAAC,CAAA;AAE3E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAmBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAAyD,CAAA;AAE7E,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
1
+ {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Breadcrumb/props.ts"],"names":[],"mappings":";AA+BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAEhF,aAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,eAAe,GAAG,kBAAkB,GACvC,cAAc,CAAC,eAAe,EAAE,eAAe,CAAC,CAAA;AAElD,aAAK,eAAe,GAAG,cAAc,CAAC,YAAY,GAAG,OAAO,GAAG,WAAW,CAAC,CAAA;AAE3E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAKvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAAyD,CAAA;AAE7E,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}