@instructure/ui-side-nav-bar 8.38.2-snapshot-11

package/types/SideNavBar/SideNavBarItem/SideNavBarItemLocator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SideNavBarItemLocator.d.ts","sourceRoot":"","sources":["../../../src/SideNavBar/SideNavBarItem/SideNavBarItemLocator.ts"],"names":[],"mappings":"AA+BA,eAAO,MAAM,qBAAqB;;sCACF,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCAAL,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCAAL,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCAAL,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sCAAL,GAAG,EAAE;;oJACnC,CAAA"}

package/types/SideNavBar/SideNavBarItem/index.d.ts

@@ -0,0 +1,48 @@
+/** @jsx jsx */
+import { Component } from 'react';
+import { jsx } from '@instructure/emotion';
+import type { SideNavBarItemProps } from './props';
+/**
+---
+parent: SideNavBar
+id: SideNavBar.Item
+---
+@tsProps
+**/
+declare class SideNavBarItem extends Component<SideNavBarItemProps> {
+    static readonly componentId = "SideNavBar.Item";
+    static allowedProps: readonly (keyof {
+        elementRef?: ((el: Element | null) => void) | undefined;
+        icon: import("react").ReactNode;
+        label: import("react").ReactNode;
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        href?: string | undefined;
+        onClick?: ((event: import("react").MouseEvent<Element, MouseEvent>) => void) | undefined;
+        selected?: boolean | undefined;
+        minimized?: boolean | undefined;
+    })[];
+    static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
+        elementRef?: ((el: Element | null) => void) | undefined;
+        icon: import("react").ReactNode;
+        label: import("react").ReactNode;
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        href?: string | undefined;
+        onClick?: ((event: import("react").MouseEvent<Element, MouseEvent>) => void) | undefined;
+        selected?: boolean | undefined;
+        minimized?: boolean | undefined;
+    }>;
+    static defaultProps: {
+        readonly as: "a";
+        readonly selected: false;
+        readonly minimized: false;
+    };
+    ref: Element | null;
+    handleRef: (el: Element | null) => void;
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    renderLink(addRef: boolean): jsx.JSX.Element;
+    render(): jsx.JSX.Element;
+}
+export default SideNavBarItem;
+export { SideNavBarItem };
+//# sourceMappingURL=index.d.ts.map

package/types/SideNavBar/SideNavBarItem/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/SideNavBar/SideNavBarItem/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAGlD;;;;;;GAMG;AACH,cAEM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,YAAY;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;MAIT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAM9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,UAAU,CAAC,MAAM,EAAE,OAAO;IA0B1B,MAAM;CAYP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}

package/types/SideNavBar/SideNavBarItem/locator.d.ts

@@ -0,0 +1,4 @@
+import { SideNavBarItemLocator } from './SideNavBarItemLocator';
+export { SideNavBarItemLocator };
+export default SideNavBarItemLocator;
+//# sourceMappingURL=locator.d.ts.map

package/types/SideNavBar/SideNavBarItem/locator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"locator.d.ts","sourceRoot":"","sources":["../../../src/SideNavBar/SideNavBarItem/locator.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,OAAO,EAAE,qBAAqB,EAAE,CAAA;AAChC,eAAe,qBAAqB,CAAA"}

package/types/SideNavBar/SideNavBarItem/props.d.ts

@@ -0,0 +1,46 @@
+import React from 'react';
+import type { AsElementType, PropValidators, SideNavBarItemTheme, OtherHTMLAttributes } from '@instructure/shared-types';
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
+type SideNavBarItemOwnProps = {
+    /**
+     * The reference to the underlying HTML element
+     */
+    elementRef?: (el: Element | null) => void;
+    /**
+     * The visual to display (ex. an Image, Logo, Avatar, or Icon)
+     */
+    icon: React.ReactNode;
+    /**
+     * The text to display  for the SideNavBar Link
+     */
+    label: React.ReactNode;
+    /**
+     * The element type to render as (will default to `<a>` if href is provided)
+     */
+    as?: AsElementType;
+    /**
+     * If the SideNavBarItem goes to a new page, pass an href
+     */
+    href?: string;
+    /**
+     * If the SideNavBarItem does not go to a new page pass an onClick
+     */
+    onClick?: (event: React.MouseEvent) => void;
+    /**
+     * Denotes which SideNavBarItem is currently selected
+     */
+    selected?: boolean;
+    /**
+     * When minimized is set to true, the `<SideNavBar />` shows icons only while the text becomes a tooltip. When it is set to false, the `<SideNavBar />` shows text in addition to the icons
+     */
+    minimized?: boolean;
+};
+type PropKeys = keyof SideNavBarItemOwnProps;
+type AllowedPropKeys = Readonly<Array<PropKeys>>;
+type SideNavBarItemProps = SideNavBarItemOwnProps & WithStyleProps<SideNavBarItemTheme, SideNavBarItemStyle> & OtherHTMLAttributes<SideNavBarItemOwnProps>;
+type SideNavBarItemStyle = ComponentStyle<'navigationItem' | 'icon' | 'label'>;
+declare const propTypes: PropValidators<PropKeys>;
+declare const allowedProps: AllowedPropKeys;
+export type { SideNavBarItemProps, SideNavBarItemStyle };
+export { propTypes, allowedProps };
+//# sourceMappingURL=props.d.ts.map

package/types/SideNavBar/SideNavBarItem/props.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/SideNavBar/SideNavBarItem/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,KAAK,sBAAsB,GAAG;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IACzC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAA;IACrB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAA;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,sBAAsB,CAAA;AAE5C,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,mBAAmB,GAAG,sBAAsB,GAC/C,cAAc,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,GACxD,mBAAmB,CAAC,sBAAsB,CAAC,CAAA;AAE7C,KAAK,mBAAmB,GAAG,cAAc,CAAC,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;AAE9E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CASvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/SideNavBar/SideNavBarItem/styles.d.ts

@@ -0,0 +1,15 @@
+import type { SideNavBarItemTheme } from '@instructure/shared-types';
+import type { SideNavBarItemProps, SideNavBarItemStyle } 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: SideNavBarItemTheme, props: SideNavBarItemProps) => SideNavBarItemStyle;
+export default generateStyle;
+//# sourceMappingURL=styles.d.ts.map

package/types/SideNavBar/SideNavBarItem/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/SideNavBar/SideNavBarItem/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AACpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAEvE;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,mBACD,mBAAmB,SAC5B,mBAAmB,KACzB,mBA4DF,CAAA;AAED,eAAe,aAAa,CAAA"}

package/types/SideNavBar/SideNavBarItem/theme.d.ts

@@ -0,0 +1,10 @@
+import type { Theme } from '@instructure/ui-themes';
+import { SideNavBarItemTheme } from '@instructure/shared-types';
+/**
+ * Generates the theme object for the component from the theme and provided additional information
+ * @param  {Object} theme The actual theme object.
+ * @return {Object} The final theme object with the overrides and component variables
+ */
+declare const generateComponentTheme: (theme: Theme) => SideNavBarItemTheme;
+export default generateComponentTheme;
+//# sourceMappingURL=theme.d.ts.map

package/types/SideNavBar/SideNavBarItem/theme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/SideNavBar/SideNavBarItem/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAsB,MAAM,wBAAwB,CAAA;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAE/D;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,mBA+C9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}