@wistia/ui 0.4.5 → 0.4.6-beta.12aa477c.cc6313b

package/dist/index.d.mts

@@ -60,15 +60,15 @@ type AddEventListenerType = (type: string, listener: (evt: Event) => void, optio
 type RemoveEventListenerType = (type: string, listener: (evt: Event) => void, options?: AddEventListenerOptions | boolean) => void;
 declare const useEvent: <T extends Event>(eventName: Parameters<AddEventListenerType>[0], eventHandler: (event: T) => unknown, eventTarget?: unknown, eventOptions?: Parameters<RemoveEventListenerType>[2]) => void;
 
+type EventHandler = (event: KeyboardEvent) => void;
 type KeyFilterPredicate = (evt: KeyboardEvent) => boolean;
 type KeyFilter = KeyFilterPredicate | boolean | string | null | undefined;
-type EventHandler = (event: KeyboardEvent) => unknown;
 type UseKeyOptions = {
     eventName?: string;
     eventTarget?: Parameters<typeof useEvent>[2];
     eventOptions?: Parameters<typeof useEvent>[3];
 };
-declare const useKey: (key: KeyFilter, eventHandler: EventHandler, options?: UseKeyOptions, dependencies?: unknown[]) => void;
+declare const useKey: (key: KeyFilter, eventHandler: EventHandler, { eventName, eventTarget, eventOptions }?: UseKeyOptions) => void;
 
 type AriaLiveContextType = {
     announce: (message: string, politeness?: 'assertive' | 'polite') => void;
@@ -526,14 +526,15 @@ type BreadcrumbsProps = ComponentPropsWithoutRef<'div'> & {
     children: ReactNode;
 };
 /**
- * Used to display a screens's location within a hierarchical structure
+ * Used to display a screens's location within a hierarchical structure. Each `Breadcrumb` is a composed version of
+ * [Button](?path=/docs/components-button--docs). See it's documentation for additional functionality.
  */
 declare const Breadcrumbs: {
     ({ children, ...props }: BreadcrumbsProps): JSX.Element;
     displayName: string;
 };
 
-type BreadcrumbProps = {
+type BreadcrumbProps = ButtonAsLinkProps & {
     /**
      * An [Icon](../?path=/docs/components-icon--docs) to show at the beginning of the breadcrumb
      * */
@@ -547,7 +548,7 @@ type BreadcrumbProps = {
      */
     href: string;
 };
-declare const Breadcrumb: ({ icon, href, children }: BreadcrumbProps) => react_jsx_runtime.JSX.Element;
+declare const Breadcrumb: ({ icon, href, children, ...props }: BreadcrumbProps) => react_jsx_runtime.JSX.Element;
 
 type ButtonGroupProps = ComponentPropsWithoutRef<'div'> & {
     /**
@@ -2162,4 +2163,4 @@ declare const WistiaLogo: {
     displayName: string;
 };
 
-export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Breadcrumb, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useBoolean, useFormState, useKey, useMq, useToast, useWindowSize };
+export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Breadcrumb, type BreadcrumbProps, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useBoolean, useFormState, useKey, useMq, useToast, useWindowSize };

package/dist/index.d.ts

@@ -60,15 +60,15 @@ type AddEventListenerType = (type: string, listener: (evt: Event) => void, optio
 type RemoveEventListenerType = (type: string, listener: (evt: Event) => void, options?: AddEventListenerOptions | boolean) => void;
 declare const useEvent: <T extends Event>(eventName: Parameters<AddEventListenerType>[0], eventHandler: (event: T) => unknown, eventTarget?: unknown, eventOptions?: Parameters<RemoveEventListenerType>[2]) => void;
 
+type EventHandler = (event: KeyboardEvent) => void;
 type KeyFilterPredicate = (evt: KeyboardEvent) => boolean;
 type KeyFilter = KeyFilterPredicate | boolean | string | null | undefined;
-type EventHandler = (event: KeyboardEvent) => unknown;
 type UseKeyOptions = {
     eventName?: string;
     eventTarget?: Parameters<typeof useEvent>[2];
     eventOptions?: Parameters<typeof useEvent>[3];
 };
-declare const useKey: (key: KeyFilter, eventHandler: EventHandler, options?: UseKeyOptions, dependencies?: unknown[]) => void;
+declare const useKey: (key: KeyFilter, eventHandler: EventHandler, { eventName, eventTarget, eventOptions }?: UseKeyOptions) => void;
 
 type AriaLiveContextType = {
     announce: (message: string, politeness?: 'assertive' | 'polite') => void;
@@ -526,14 +526,15 @@ type BreadcrumbsProps = ComponentPropsWithoutRef<'div'> & {
     children: ReactNode;
 };
 /**
- * Used to display a screens's location within a hierarchical structure
+ * Used to display a screens's location within a hierarchical structure. Each `Breadcrumb` is a composed version of
+ * [Button](?path=/docs/components-button--docs). See it's documentation for additional functionality.
  */
 declare const Breadcrumbs: {
     ({ children, ...props }: BreadcrumbsProps): JSX.Element;
     displayName: string;
 };
 
-type BreadcrumbProps = {
+type BreadcrumbProps = ButtonAsLinkProps & {
     /**
      * An [Icon](../?path=/docs/components-icon--docs) to show at the beginning of the breadcrumb
      * */
@@ -547,7 +548,7 @@ type BreadcrumbProps = {
      */
     href: string;
 };
-declare const Breadcrumb: ({ icon, href, children }: BreadcrumbProps) => react_jsx_runtime.JSX.Element;
+declare const Breadcrumb: ({ icon, href, children, ...props }: BreadcrumbProps) => react_jsx_runtime.JSX.Element;
 
 type ButtonGroupProps = ComponentPropsWithoutRef<'div'> & {
     /**
@@ -2162,4 +2163,4 @@ declare const WistiaLogo: {
     displayName: string;
 };
 
-export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Breadcrumb, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useBoolean, useFormState, useKey, useMq, useToast, useWindowSize };
+export { ActionButton, type ActionButtonProps, Avatar, type AvatarInstanceType, type AvatarProps, Badge, type BadgeProps, Box, type BoxProps, Breadcrumb, type BreadcrumbProps, Breadcrumbs, type BreadcrumbsProps, Button, ButtonGroup, type ButtonProps, Card, type CardProps, Checkbox, CheckboxGroup, CheckboxMenuItem, type ColorSchemeTypes, ColorSchemeWrapper, type ColorSchemeWrapperProps, Divider, Ellipsis, Form, FormErrorSummary, FormField, type FormFieldProps, FormGroup, type FormGroupProps, type FormProps, Heading, type HeadingProps, Icon, IconButton, type IconButtonProps, type IconNameType, Input, type InputProps, Label, type LabelProps, Link, type LinkProps, Menu, MenuItem, MenuItemDescription, MenuItemLabel, MenuLabel, MenuRadioGroup, Modal, type ModalProps, Radio, RadioGroup, RadioMenuItem, type RadioProps, ScreenReaderOnly, Stack, SubMenu, Tag, type TagProps, Text, type TextProps, Tooltip, type TooltipProps, UIProvider, WistiaLogo, colorSchemeOptions, copyToClipboard, ellipsisFlexParentStyle, ellipsisStyle, iconSizeMap, mq, useActiveMq, useAriaLive, useBoolean, useFormState, useKey, useMq, useToast, useWindowSize };