@superdispatch/ui-lab 0.18.0 → 0.20.0

package/dist-types/index.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="react" />
-import { ReactNode, ForwardRefExoticComponent, RefAttributes, Ref, AriaAttributes, MouseEventHandler, FocusEventHandler, HTMLAttributes, ComponentType, ReactElement, MouseEvent, Key, CSSProperties, ReactChild } from 'react';
+import { ReactNode, ForwardRefExoticComponent, RefAttributes, Ref, AriaAttributes, MouseEventHandler, FocusEventHandler, HTMLAttributes, AnchorHTMLAttributes, FunctionComponent, ReactElement, ComponentType, MouseEvent, Key, CSSProperties, ReactChild } from 'react';
 import { CSSTransition } from 'react-transition-group';
 import { CSSTransitionProps } from 'react-transition-group/CSSTransition';
 import { SpaceProp, NegativeSpaceProp, ResponsiveProp, ColorProp } from '@superdispatch/ui';
 import { Property } from 'csstype';
-import { ButtonBaseProps, AvatarProps, TooltipProps } from '@material-ui/core';
+import { ButtonBaseProps, AvatarProps, IconButtonProps, TooltipProps } from '@material-ui/core';
 import { FileRejection } from 'react-dropzone';
 import { StyledComponent, DefaultTheme } from 'styled-components';
 
@@ -163,6 +163,21 @@ interface FileListItemProps {
 }
 declare const FileListItem: ForwardRefExoticComponent<FileListItemProps & RefAttributes<HTMLDivElement>>;
 
+declare type LinkComponentProps = Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> & {
+    href: string;
+    truncate?: number;
+};
+interface LinkedTextProps extends Omit<LinkComponentProps, 'ref' | 'href'> {
+    children?: null | string;
+    linkComponent?: FunctionComponent<LinkComponentProps>;
+}
+declare function LinkedText({ children, linkComponent, ...props }: LinkedTextProps): ReactElement | null;
+
+interface MultilineTextProps {
+    overflowWrap?: Extract<Property.OverflowWrap, 'anywhere' | 'break-word' | 'normal'>;
+}
+declare const MultilineText: StyledComponent<"span", DefaultTheme, MultilineTextProps, never>;
+
 interface NavbarBottomBarItem {
     active?: boolean;
     value: string;
@@ -178,6 +193,14 @@ interface NavbarBottomBarProps {
 }
 declare function NavbarBottomBar({ items, hasMenuBadge, }: NavbarBottomBarProps): ReactElement;
 
+interface NavbarAccordionProps {
+    label: ReactNode;
+    icon?: ReactNode;
+    gutter?: boolean;
+    items: NavbarItemOptions[];
+    onClick: (event: MouseEvent<HTMLDivElement>) => void;
+}
+
 declare const NavbarBadge: StyledComponent<"span", DefaultTheme, {}, never>;
 declare const NavbarLabel: StyledComponent<"span", DefaultTheme, {}, never>;
 interface NavbarItemProps {
@@ -189,8 +212,9 @@ interface NavbarItemProps {
     ident?: number;
     gutter?: boolean;
     variant?: 'danger' | 'primary';
+    active?: boolean;
 }
-declare function NavbarItem({ label, gutter, badge, icon, component, onClick, variant, ident, }: NavbarItemProps): ReactElement;
+declare function NavbarItem({ label, gutter, badge, icon, component, onClick, variant, ident, active, }: NavbarItemProps): ReactElement;
 
 interface NavbarMenuItemProps {
     icon?: ReactNode;
@@ -199,6 +223,11 @@ interface NavbarMenuItemProps {
     component?: ComponentType<HTMLAttributes<HTMLElement>>;
 }
 declare function NavbarMenuItem({ label, icon, onClick, component, }: NavbarMenuItemProps): ReactElement;
+interface NavbarAccordionOptions extends NavbarAccordionProps {
+    key: Key;
+    groupKey?: Key;
+    hide?: boolean;
+}
 interface NavbarItemOptions extends NavbarItemProps {
     key: Key;
     groupKey?: Key;
@@ -206,7 +235,7 @@ interface NavbarItemOptions extends NavbarItemProps {
 }
 interface NavbarListProps {
     header: ReactNode;
-    items: NavbarItemOptions[];
+    items: Array<NavbarItemOptions | NavbarAccordionOptions>;
     footer?: ReactNode;
 }
 declare function NavbarList({ header, items, footer, }: NavbarListProps): ReactElement;
@@ -260,12 +289,30 @@ interface SidebarProps {
 }
 declare const Sidebar: ForwardRefExoticComponent<SidebarProps & RefAttributes<HTMLDivElement>>;
 
+declare function SidebarBackButton({ onClick, children, ...props }: IconButtonProps): ReactElement | null;
+
+interface SidebarContext {
+    openSidebar: () => void;
+    openSidebarContent: () => void;
+}
+declare function useSidebarContext(): SidebarContext;
 interface SidebarContainerProps {
     sidebar: ReactChild;
     children?: ReactNode;
 }
 declare const SidebarContainer: ForwardRefExoticComponent<SidebarContainerProps & RefAttributes<HTMLDivElement>>;
 
+interface SidebarContentProps {
+    dense?: boolean;
+    title: ReactNode;
+    children: ReactNode;
+    action?: ReactNode;
+    openOnMount?: boolean;
+    closeOnUnmount?: boolean;
+    onBack?: (event: MouseEvent<HTMLButtonElement>) => void;
+}
+declare function SidebarContent({ dense, action, title, children, onBack, openOnMount, closeOnUnmount, }: SidebarContentProps): ReactElement;
+
 
 declare const SidebarDivider: ForwardRefExoticComponent<RefAttributes<HTMLDivElement>>;
 
@@ -278,6 +325,7 @@ interface SidebarMenuItemProps {
     action?: ReactNode;
     avatar?: ReactNode;
     children?: ReactNode;
+    openContentOnClick?: boolean;
     secondaryActions?: ReactNode;
 }
 declare const SidebarMenuItem: ForwardRefExoticComponent<SidebarMenuItemProps & RefAttributes<HTMLDivElement>>;
@@ -322,4 +370,4 @@ interface TextBoxProps {
 }
 declare const TextBox: ForwardRefExoticComponent<TextBoxProps & RefAttributes<HTMLElement>>;
 
-export { Alert, AlertProps, AlertSeverityProp, AnchorButton, AnchorButtonProps, Banner, BorderRadiusProp, BorderWidthProp, Box, BoxProps, Button, ButtonArea, ButtonAreaProps, ButtonProps, ButtonSizeProp, ButtonVariantProp, Container, ContainerProps, DescriptionItem, DescriptionItemProps, FileDropZone, FileDropZoneProps, FileListItem, FileListItemProps, MarginProp, Navbar, NavbarAvatar, NavbarBadge, NavbarBottomBar, NavbarBottomBarItem, NavbarItem, NavbarItemOptions, NavbarItemProps, NavbarLabel, NavbarList, NavbarMenu, NavbarMenuItem, NavbarMenuItemOption, Sidebar, SidebarContainer, SidebarContainerProps, SidebarDivider, SidebarMenuItem, SidebarMenuItemAction, SidebarMenuItemActionProps, SidebarMenuItemAvatar, SidebarMenuItemAvatarProps, SidebarMenuItemProps, SidebarProps, SidebarSubheader, SidebarSubheaderProps, TextAlignProp, TextBox, TextBoxProps, TextColorProp, TextDisplayProp, TextVariantProp, formatBytes, toBytes, useNavbarContext };
+export { Alert, AlertProps, AlertSeverityProp, AnchorButton, AnchorButtonProps, Banner, BorderRadiusProp, BorderWidthProp, Box, BoxProps, Button, ButtonArea, ButtonAreaProps, ButtonProps, ButtonSizeProp, ButtonVariantProp, Container, ContainerProps, DescriptionItem, DescriptionItemProps, FileDropZone, FileDropZoneProps, FileListItem, FileListItemProps, LinkComponentProps, LinkedText, LinkedTextProps, MarginProp, MultilineText, MultilineTextProps, Navbar, NavbarAccordionOptions, NavbarAvatar, NavbarBadge, NavbarBottomBar, NavbarBottomBarItem, NavbarItem, NavbarItemOptions, NavbarItemProps, NavbarLabel, NavbarList, NavbarMenu, NavbarMenuItem, NavbarMenuItemOption, Sidebar, SidebarBackButton, SidebarContainer, SidebarContainerProps, SidebarContent, SidebarContentProps, SidebarDivider, SidebarMenuItem, SidebarMenuItemAction, SidebarMenuItemActionProps, SidebarMenuItemAvatar, SidebarMenuItemAvatarProps, SidebarMenuItemProps, SidebarProps, SidebarSubheader, SidebarSubheaderProps, TextAlignProp, TextBox, TextBoxProps, TextColorProp, TextDisplayProp, TextVariantProp, formatBytes, toBytes, useNavbarContext, useSidebarContext };