@instructure/ui-breadcrumb 8.14.1-snapshot.0 → 8.14.1-snapshot.12

package/types/Breadcrumb/BreadcrumbLink/index.d.ts

@@ -5,23 +5,24 @@ import type { BreadcrumbLinkProps } from './props';
 parent: Breadcrumb
 id: Breadcrumb.Link
 ---
+@tsProps
 **/
 declare class BreadcrumbLink extends Component<BreadcrumbLinkProps> {
     static readonly componentId = "Breadcrumb.Link";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         children: React.ReactNode;
         href?: string | undefined;
-        onClick?: ((...args: any[]) => any) | undefined;
+        onClick?: ((event: React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewOwnProps, MouseEvent>) => void) | undefined;
         size?: "small" | "medium" | "large" | undefined;
-        renderIcon?: React.ReactNode | ((...args: any[]) => any);
+        renderIcon?: React.ReactNode | (() => React.ReactNode);
         iconPlacement?: "start" | "end" | undefined;
     }>;
     static allowedProps: readonly (keyof {
         children: React.ReactNode;
         href?: string | undefined;
-        onClick?: ((...args: any[]) => any) | undefined;
+        onClick?: ((event: React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewOwnProps, MouseEvent>) => void) | undefined;
         size?: "small" | "medium" | "large" | undefined;
-        renderIcon?: React.ReactNode | ((...args: any[]) => any);
+        renderIcon?: React.ReactNode | (() => React.ReactNode);
         iconPlacement?: "start" | "end" | undefined;
     })[];
     static defaultProps: {};

package/types/Breadcrumb/BreadcrumbLink/index.d.ts.map

@@ -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"}
+{"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

@@ -1,16 +1,37 @@
 import React from 'react';
 import type { OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
+import type { ViewOwnProps } from '@instructure/ui-view';
 declare type BreadcrumbLinkOwnProps = {
+    /**
+     * Content to render as the crumb, generally should be text.
+     */
     children: React.ReactNode;
+    /**
+     * Link the crumb should direct to; if an href is provided, the crumb will render as a link
+     */
     href?: string;
-    onClick?: (...args: any[]) => any;
+    /**
+     * If the Breadcrumb.Link has an onClick prop (and no href), it will render as a button
+     */
+    onClick?: (event: React.MouseEvent<ViewOwnProps, MouseEvent>) => void;
+    /**
+     * Sets the font-size of the breadcrumb text
+     */
     size?: 'small' | 'medium' | 'large';
-    renderIcon?: React.ReactNode | ((...args: any[]) => any);
+    /**
+     * Add an icon to the Breadcrumb.Link
+     */
+    renderIcon?: React.ReactNode | (() => React.ReactNode);
+    /**
+     * Place the icon before or after the text in the Breadcrumb.Link
+     */
     iconPlacement?: 'start' | 'end';
 };
 declare type PropKeys = keyof BreadcrumbLinkOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type BreadcrumbLinkProps = BreadcrumbLinkOwnProps & OtherHTMLAttributes<BreadcrumbLinkOwnProps>;
+declare type BreadcrumbLinkProps = BreadcrumbLinkOwnProps & OtherHTMLAttributes<BreadcrumbLinkOwnProps> & {
+    to?: string;
+};
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
 export type { BreadcrumbLinkProps };

package/types/Breadcrumb/BreadcrumbLink/props.d.ts.map

@@ -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"}
+{"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/index.d.ts

@@ -7,6 +7,7 @@ import type { BreadcrumbProps } from './props';
 ---
 category: components
 ---
+@tsProps
 **/
 declare class Breadcrumb extends Component<BreadcrumbProps> {
     static readonly componentId = "Breadcrumb";
@@ -29,7 +30,7 @@ declare class Breadcrumb extends Component<BreadcrumbProps> {
     ref: Element | null;
     handleRef: (el: Element | null) => void;
     componentDidMount(): void;
-    componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
+    componentDidUpdate(): void;
     static Link: typeof BreadcrumbLink;
     renderChildren(): jsx.JSX.Element[] | null | undefined;
     render(): jsx.JSX.Element;

package/types/Breadcrumb/index.d.ts.map

@@ -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"}
+{"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

@@ -2,9 +2,23 @@
 import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
 import type { BreadcrumbTheme, PropValidators } from '@instructure/shared-types';
 declare type BreadcrumbOwnProps = {
+    /**
+     * children of type Breadcrumb.Link
+     */
     children?: React.ReactNode;
+    /**
+     * An accessible label for the navigation
+     */
     label: string;
+    /**
+     * Sets the font-size of the breadcrumb text
+     */
     size?: 'small' | 'medium' | 'large';
+    /**
+     * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+     * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+     * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+     */
     margin?: Spacing;
 };
 declare type PropKeys = keyof BreadcrumbOwnProps;

package/types/Breadcrumb/props.d.ts.map

@@ -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"}
+{"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"}