@instructure/ui-truncate-list 8.27.1-snapshot-13

package/types/TruncateList/TruncateListLocator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TruncateListLocator.d.ts","sourceRoot":"","sources":["../../src/TruncateList/TruncateListLocator.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAK5D,eAAO,MAAM,mBAAmB;;oCACF,GAAG,EAAE;uCAGF,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAHR,GAAG,EAAE;uCAGF,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAHR,GAAG,EAAE;uCAGF,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAHR,GAAG,EAAE;uCAGF,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAHR,GAAG,EAAE;uCAGF,GAAG,EAAE;;0KAGpC,CAAA"}

package/types/TruncateList/index.d.ts

@@ -0,0 +1,62 @@
+/** @jsx jsx */
+import { Component } from 'react';
+import { jsx } from '@instructure/emotion';
+import type { TruncateListProps, TruncateListState } from './props';
+/**
+---
+category: components/utilities
+---
+@tsProps
+**/
+declare class TruncateList extends Component<TruncateListProps, TruncateListState> {
+    static readonly componentId = "TruncateList";
+    static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
+        children?: import("react").ReactNode;
+        visibleItemsCount?: number | undefined;
+        renderHiddenItemMenu?: ((hiddenChildren: (string | number | import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | import("react").ReactFragment | import("react").ReactPortal)[]) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>) | undefined;
+        onUpdate?: (({ visibleItemsCount }: {
+            visibleItemsCount: number;
+        }) => void) | undefined;
+        itemSpacing?: string | undefined;
+        fixMenuTriggerWidth?: string | undefined;
+        debounce?: number | undefined;
+        elementRef?: ((element: HTMLUListElement | null) => void) | undefined;
+    }>;
+    static allowedProps: readonly (keyof {
+        children?: import("react").ReactNode;
+        visibleItemsCount?: number | undefined;
+        renderHiddenItemMenu?: ((hiddenChildren: (string | number | import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | import("react").ReactFragment | import("react").ReactPortal)[]) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>) | undefined;
+        onUpdate?: (({ visibleItemsCount }: {
+            visibleItemsCount: number;
+        }) => void) | undefined;
+        itemSpacing?: string | undefined;
+        fixMenuTriggerWidth?: string | undefined;
+        debounce?: number | undefined;
+        elementRef?: ((element: HTMLUListElement | null) => void) | undefined;
+    })[];
+    static defaultProps: {
+        itemSpacing: string;
+        debounce: number;
+    };
+    ref: HTMLUListElement | null;
+    private _menuTriggerRef;
+    private _debouncedHandleResize?;
+    private _resizeListener?;
+    handleRef: (el: HTMLUListElement | null) => void;
+    constructor(props: TruncateListProps);
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: TruncateListProps, prevState: TruncateListState): void;
+    componentWillUnmount(): void;
+    get childrenArray(): (string | number | import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | import("react").ReactFragment | import("react").ReactPortal)[];
+    get visibleChildren(): (string | number | import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | import("react").ReactFragment | import("react").ReactPortal)[];
+    get hiddenChildren(): (string | number | import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | import("react").ReactFragment | import("react").ReactPortal)[];
+    calcMenuTriggerWidth(): number;
+    measureItems: () => {
+        visibleItemsCount: number;
+    };
+    handleResize: () => void;
+    render(): jsx.JSX.Element;
+}
+export { TruncateList };
+export default TruncateList;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/TruncateList/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAY,SAAS,EAAE,MAAM,OAAO,CAAA;AAS3C,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAKrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEnE;;;;;GAKG;AACH,cAEM,YAAa,SAAQ,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IACxE,MAAM,CAAC,QAAQ,CAAC,WAAW,kBAAiB;IAE5C,MAAM,CAAC,SAAS;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;MAGlB;IAED,GAAG,EAAE,gBAAgB,GAAG,IAAI,CAAO;IAEnC,OAAO,CAAC,eAAe,CAA6B;IAEpD,OAAO,CAAC,sBAAsB,CAAC,CAAW;IAC1C,OAAO,CAAC,eAAe,CAAC,CAAgB;IAExC,SAAS,OAAQ,gBAAgB,GAAG,IAAI,UAQvC;gBAEW,KAAK,EAAE,iBAAiB;IASpC,iBAAiB;IAoCjB,kBAAkB,CAChB,SAAS,EAAE,iBAAiB,EAC5B,SAAS,EAAE,iBAAiB;IA6B9B,oBAAoB;IAUpB,IAAI,aAAa,+KAEhB;IAED,IAAI,eAAe,+KAelB;IAED,IAAI,cAAc,+KASjB;IAED,oBAAoB;IAqBpB,YAAY;;MAwCX;IAED,YAAY,aASX;IAED,MAAM;CAuCP;AAED,OAAO,EAAE,YAAY,EAAE,CAAA;AACvB,eAAe,YAAY,CAAA"}

package/types/TruncateList/props.d.ts

@@ -0,0 +1,58 @@
+import React from 'react';
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
+import type { OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
+declare type TruncateListOwnProps = {
+    /**
+     * List of items in the truncated list
+     */
+    children?: React.ReactNode;
+    /**
+     * Sets the number of navigation items that are visible.
+     * If not set, the list is not truncated.
+     */
+    visibleItemsCount?: number;
+    /**
+     * When there are list items hidden, an optional element
+     * (dropdown menu, link, etc.) can be provided to display them
+     * (renders at the end of the list).
+     */
+    renderHiddenItemMenu?: (hiddenChildren: Exclude<React.ReactNode, boolean | null | undefined>[]) => React.ReactElement;
+    /**
+     * Called whenever the navigation items are updated or the size of
+     * the navigation changes. Passes in the `visibleItemsCount` as
+     * a parameter.
+     */
+    onUpdate?: ({ visibleItemsCount }: {
+        visibleItemsCount: number;
+    }) => void;
+    /**
+     * The spacing between list items (in 'rem', 'em' or 'px')
+     */
+    itemSpacing?: string;
+    /**
+     * Fix width of the Menu trigger (in 'rem', 'em' or 'px')
+     */
+    fixMenuTriggerWidth?: string;
+    /**
+     * The rate (in ms) the component responds to container resizing or
+     * an update to one of its child items
+     */
+    debounce?: number;
+    /**
+     * Provides a reference to the underlying ul element
+     */
+    elementRef?: (element: HTMLUListElement | null) => void;
+};
+declare type PropKeys = keyof TruncateListOwnProps;
+declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
+declare type TruncateListProps = TruncateListOwnProps & WithStyleProps<null, TruncateListStyle> & OtherHTMLAttributes<TruncateListOwnProps>;
+declare type TruncateListStyle = ComponentStyle<'truncateList' | 'listItem' | 'menuTrigger'>;
+declare type TruncateListState = {
+    isMeasuring: boolean;
+    menuTriggerWidth?: number;
+};
+declare const propTypes: PropValidators<PropKeys>;
+declare const allowedProps: AllowedPropKeys;
+export type { TruncateListProps, TruncateListStyle, TruncateListState };
+export { propTypes, allowedProps };
+//# sourceMappingURL=props.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/TruncateList/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,aAAK,oBAAoB,GAAG;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAE1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,CACrB,cAAc,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,KACnE,KAAK,CAAC,YAAY,CAAA;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,iBAAiB,EAAE,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IAEzE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,KAAK,IAAI,CAAA;CACxD,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,oBAAoB,CAAA;AAE1C,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,iBAAiB,GAAG,oBAAoB,GAC3C,cAAc,CAAC,IAAI,EAAE,iBAAiB,CAAC,GACvC,mBAAmB,CAAC,oBAAoB,CAAC,CAAA;AAE3C,aAAK,iBAAiB,GAAG,cAAc,CACrC,cAAc,GAAG,UAAU,GAAG,aAAa,CAC5C,CAAA;AAED,aAAK,iBAAiB,GAAG;IACvB,WAAW,EAAE,OAAO,CAAA;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CASvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,CAAA;AACvE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/TruncateList/styles.d.ts

@@ -0,0 +1,14 @@
+import type { TruncateListProps, TruncateListStyle } from './props';
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+declare const generateStyle: (_componentTheme: null, props: TruncateListProps) => TruncateListStyle;
+export default generateStyle;
+//# sourceMappingURL=styles.d.ts.map

package/types/TruncateList/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/TruncateList/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEnE;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,oBACA,IAAI,SACd,iBAAiB,KACvB,iBAuCF,CAAA;AAED,eAAe,aAAa,CAAA"}

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export { TruncateList } from './TruncateList';
+export type { TruncateListProps } from './TruncateList/props';
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,YAAY,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA"}