@instructure/ui-buttons 8.13.1-snapshot.41 → 8.13.1-snapshot.47

package/types/CondensedButton/props.d.ts

@@ -1,23 +1,64 @@
 import React from 'react';
 import type { Spacing, WithStyleProps } from '@instructure/emotion';
-import type { AsElementType, BaseButtonTheme, OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
+import type { ToProp, AsElementType, BaseButtonTheme, OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
 import type { Cursor } from '@instructure/ui-prop-types';
+import type { ViewProps } from '@instructure/ui-view';
 declare type CondensedButtonOwnProps = {
+    /**
+     * Specifies the `CondensedButton` children.
+     */
     children?: React.ReactNode;
+    /**
+     * Specifies the type of the `CondensedButton`'s underlying html element.
+     */
     type?: 'button' | 'submit' | 'reset';
+    /**
+     * The size of the `CondensedButton`
+     */
     size?: 'small' | 'medium' | 'large';
+    /**
+     * Provides a reference to the `CondensedButton`'s underlying html element.
+     */
     elementRef?: (element: Element | null) => void;
+    /**
+     * The element to render as the component root, `button` by default.
+     */
     as?: AsElementType;
+    /**
+     * Specifies if interaction with the `CondensedButton` is enabled, disabled, or readonly.
+     */
     interaction?: 'enabled' | 'disabled' | 'readonly';
+    /**
+     * Specifies the color for the `CondensedButton`.
+     */
     color?: 'primary' | 'primary-inverse';
+    /**
+     * 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;
+    /**
+     * Specify a mouse cursor to use when hovering over the button.
+     * The `pointer` cursor is used by default.
+     */
     cursor?: Cursor;
+    /**
+     * Specifies an href attribute for the `CondensedButton`'s underlying html element.
+     */
     href?: string;
-    renderIcon?: React.ReactNode | ((...args: any[]) => any);
+    /**
+     * An icon, or function that returns an icon.
+     */
+    renderIcon?: React.ReactNode | (() => React.ReactNode);
+    /**
+     * Callback fired when the `CondensedButton` is clicked.
+     */
+    onClick?: (event: React.KeyboardEvent<ViewProps> | React.MouseEvent<ViewProps>) => void;
 };
 declare type PropKeys = keyof CondensedButtonOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type CondensedButtonProps = CondensedButtonOwnProps & WithStyleProps<BaseButtonTheme, null> & OtherHTMLAttributes<CondensedButtonOwnProps>;
+declare type CondensedButtonProps = CondensedButtonOwnProps & WithStyleProps<BaseButtonTheme, null> & OtherHTMLAttributes<CondensedButtonOwnProps> & ToProp;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
 export type { CondensedButtonProps };

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/CondensedButton/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAExD,aAAK,uBAAuB,GAAG;IAC7B,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;IACpC,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,WAAW,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAA;IACjD,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAA;IACrC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;CACzD,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,uBAAuB,CAAA;AAE7C,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,oBAAoB,GAAG,uBAAuB,GACjD,cAAc,CAAC,eAAe,EAAE,IAAI,CAAC,GACrC,mBAAmB,CAAC,uBAAuB,CAAC,CAAA;AAE9C,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAgDvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAYnB,CAAA;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/CondensedButton/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,aAAK,uBAAuB,GAAG;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAE9C;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAA;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,CAAA;IAErC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAEtD;;OAEG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,KAChE,IAAI,CAAA;CACV,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,uBAAuB,CAAA;AAE7C,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,oBAAoB,GAAG,uBAAuB,GACjD,cAAc,CAAC,eAAe,EAAE,IAAI,CAAC,GACrC,mBAAmB,CAAC,uBAAuB,CAAC,GAC5C,MAAM,CAAA;AAER,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAavC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAanB,CAAA;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAA;AACpC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/IconButton/index.d.ts

@@ -1,15 +1,17 @@
 import React, { Component } from 'react';
+import { BaseButton } from '../BaseButton';
 import type { IconButtonProps } from './props';
 /**
 ---
 category: components
 ---
+@tsProps
 **/
 declare class IconButton extends Component<IconButtonProps> {
     static readonly componentId = "IconButton";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
-        children?: React.ReactNode | ((...args: any[]) => React.ReactNode);
-        renderIcon?: React.ReactNode | ((...args: any[]) => any);
+        children?: React.ReactNode | (() => React.ReactNode);
+        renderIcon?: React.ReactNode | (() => React.ReactNode);
         screenReaderLabel: string;
         type?: "button" | "submit" | "reset" | undefined;
         size?: "small" | "medium" | "large" | undefined;
@@ -24,10 +26,11 @@ declare class IconButton extends Component<IconButtonProps> {
         margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
         cursor?: import("@instructure/ui-prop-types/types/cursor").Cursor | undefined;
         href?: string | undefined;
+        onClick?: ((event: React.KeyboardEvent<import("@instructure/ui-view/types/View/props").ViewProps> | React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewProps, MouseEvent>) => void) | undefined;
     }>;
     static allowedProps: readonly (keyof {
-        children?: React.ReactNode | ((...args: any[]) => React.ReactNode);
-        renderIcon?: React.ReactNode | ((...args: any[]) => any);
+        children?: React.ReactNode | (() => React.ReactNode);
+        renderIcon?: React.ReactNode | (() => React.ReactNode);
         screenReaderLabel: string;
         type?: "button" | "submit" | "reset" | undefined;
         size?: "small" | "medium" | "large" | undefined;
@@ -42,13 +45,13 @@ declare class IconButton extends Component<IconButtonProps> {
         margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
         cursor?: import("@instructure/ui-prop-types/types/cursor").Cursor | undefined;
         href?: string | undefined;
+        onClick?: ((event: React.KeyboardEvent<import("@instructure/ui-view/types/View/props").ViewProps> | React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewProps, MouseEvent>) => void) | undefined;
     })[];
     static defaultProps: {
-        children: null;
         type: string;
         size: string;
-        elementRef: (el: any) => void;
         as: string;
+        interaction: undefined;
         color: string;
         shape: string;
         withBackground: boolean;
@@ -56,10 +59,10 @@ declare class IconButton extends Component<IconButtonProps> {
         margin: string;
         cursor: string;
     };
-    _baseButton: null;
+    _baseButton: BaseButton | null;
     ref: Element | null;
     handleRef: (el: Element | null) => void;
-    get focused(): null;
+    get focused(): boolean | null;
     focus(): void;
     render(): JSX.Element;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/IconButton/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAYxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9C;;;;GAIG;AAGH,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;;;;;;;;;;;;MAclB;IAED,WAAW,OAAO;IAElB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,IAAI,OAAO,SAGV;IAED,KAAK;IAKL,MAAM;CAkDP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/IconButton/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AASxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAG1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAE9C;;;;;GAKG;AAGH,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;;;;;;;;;;;MAYlB;IAED,WAAW,EAAE,UAAU,GAAG,IAAI,CAAO;IAErC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,IAAI,OAAO,mBAEV;IAED,KAAK;IAIL,MAAM;CAiDP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}

package/types/IconButton/props.d.ts

@@ -1,28 +1,84 @@
 import React from 'react';
 import type { Spacing, WithStyleProps } from '@instructure/emotion';
-import type { AsElementType, PropValidators, BaseButtonTheme, OtherHTMLAttributes } from '@instructure/shared-types';
+import type { ToProp, AsElementType, PropValidators, BaseButtonTheme, OtherHTMLAttributes } from '@instructure/shared-types';
 import type { Cursor } from '@instructure/ui-prop-types';
+import type { ViewProps } from '@instructure/ui-view';
 declare type IconButtonOwnProps = {
-    children?: React.ReactNode | ((...args: any[]) => React.ReactNode);
-    renderIcon?: React.ReactNode | ((...args: any[]) => any);
+    /**
+     * An icon, or function returning an icon (identical to the `renderIcon` prop).
+     */
+    children?: React.ReactNode | (() => React.ReactNode);
+    /**
+     * An icon, or function that returns an icon (identical to the `children` prop).
+     */
+    renderIcon?: React.ReactNode | (() => React.ReactNode);
+    /**
+     * An accessible label for the `IconButton`.
+     */
     screenReaderLabel: string;
+    /**
+     * Specifies the type of the `IconButton`'s underlying html element.
+     */
     type?: 'button' | 'submit' | 'reset';
+    /**
+     * The size of the `IconButton`
+     */
     size?: 'small' | 'medium' | 'large';
+    /**
+     * Provides a reference to the `IconButton`'s underlying html element.
+     */
     elementRef?: (element: Element | null) => void;
+    /**
+     * The element to render as the component root, `button` by default.
+     */
     as?: AsElementType;
+    /**
+     * Specifies if interaction with the `IconButton` is enabled, disabled, or readonly.
+     */
     interaction?: 'enabled' | 'disabled' | 'readonly';
+    /**
+     * Specifies the color for the `IconButton`.
+     */
     color?: 'primary' | 'primary-inverse' | 'secondary' | 'success' | 'danger';
+    /**
+     * Override the `Button`'s default focus outline color.
+     */
     focusColor?: 'info' | 'inverse';
+    /**
+     * Specifies if the `IconButton` shape should be a circle or rectangle.
+     */
     shape?: 'rectangle' | 'circle';
+    /**
+     * Specifies if the `IconButton` should render with a solid background. When false, the background is transparent.
+     */
     withBackground?: boolean;
+    /**
+     * Specifies if the `IconButton` should render with a border.
+     */
     withBorder?: boolean;
+    /**
+     * 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;
+    /**
+     * Specify a mouse cursor to use when hovering over the button.
+     * The `pointer` cursor is used by default.
+     */
     cursor?: Cursor;
+    /**
+     * Specifies an href attribute for the `IconButton`'s underlying html element.
+     */
     href?: string;
+    /**
+     * Callback fired when the `Button` is clicked.
+     */
+    onClick?: (event: React.KeyboardEvent<ViewProps> | React.MouseEvent<ViewProps>) => void;
 };
 declare type PropKeys = keyof IconButtonOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type IconButtonProps = IconButtonOwnProps & WithStyleProps<BaseButtonTheme, null> & OtherHTMLAttributes<IconButtonOwnProps>;
+declare type IconButtonProps = IconButtonOwnProps & WithStyleProps<BaseButtonTheme, null> & OtherHTMLAttributes<IconButtonOwnProps> & ToProp;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
 export type { IconButtonProps };

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/IconButton/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAExD,aAAK,kBAAkB,GAAG;IACxB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAClE,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACxD,iBAAiB,EAAE,MAAM,CAAA;IACzB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;IACpC,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,WAAW,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAA;IACjD,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAA;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,KAAK,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAA;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,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,IAAI,CAAC,GACrC,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;AAEzC,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA0EvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAiBnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,CAAA;AAC/B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/IconButton/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,EACV,MAAM,EACN,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,aAAK,kBAAkB,GAAG;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAEpD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAEtD;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAE9C;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAA;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAA;IAE1E;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAA;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,KAChE,IAAI,CAAA;CACV,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,IAAI,CAAC,GACrC,mBAAmB,CAAC,kBAAkB,CAAC,GACvC,MAAM,CAAA;AAER,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAwBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAkBnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,CAAA;AAC/B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/ToggleButton/index.d.ts

@@ -1,23 +1,24 @@
 import React, { Component } from 'react';
-import type { ToggleButtonProps } from './props';
+import type { ToggleButtonProps, ToggleButtonState } from './props';
 /**
 ---
 category: components
 ---
+@tsProps
 **/
-declare class ToggleButton extends Component<ToggleButtonProps> {
+declare class ToggleButton extends Component<ToggleButtonProps, ToggleButtonState> {
     static readonly componentId = "ToggleButton";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         screenReaderLabel: string;
         renderTooltipContent: React.ReactNode | ((...args: any[]) => any);
-        renderIcon: React.ReactNode | ((...args: any[]) => any);
+        renderIcon: React.ReactNode | (() => React.ReactNode);
         status: "pressed" | "unpressed";
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
         interaction?: "enabled" | "disabled" | "readonly" | undefined;
         size?: "small" | "medium" | "large" | undefined;
         elementRef?: ((element: Element | null) => void) | undefined;
-        onClick?: ((...args: any[]) => any) | undefined;
-        color?: string | undefined;
+        onClick?: ((event: React.KeyboardEvent<import("@instructure/ui-view/types/View/props").ViewProps> | React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewProps, MouseEvent>) => void) | undefined;
+        color?: "primary" | "primary-inverse" | "secondary" | "success" | "danger" | undefined;
         isShowingTooltip?: boolean | undefined;
         mountNode?: import("@instructure/ui-position").PositionMountNode | undefined;
         placement?: import("@instructure/ui-position").PlacementPropValues | undefined;
@@ -26,14 +27,14 @@ declare class ToggleButton extends Component<ToggleButtonProps> {
     static allowedProps: readonly (keyof {
         screenReaderLabel: string;
         renderTooltipContent: React.ReactNode | ((...args: any[]) => any);
-        renderIcon: React.ReactNode | ((...args: any[]) => any);
+        renderIcon: React.ReactNode | (() => React.ReactNode);
         status: "pressed" | "unpressed";
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
         interaction?: "enabled" | "disabled" | "readonly" | undefined;
         size?: "small" | "medium" | "large" | undefined;
         elementRef?: ((element: Element | null) => void) | undefined;
-        onClick?: ((...args: any[]) => any) | undefined;
-        color?: string | undefined;
+        onClick?: ((event: React.KeyboardEvent<import("@instructure/ui-view/types/View/props").ViewProps> | React.MouseEvent<import("@instructure/ui-view/types/View/props").ViewProps, MouseEvent>) => void) | undefined;
+        color?: "primary" | "primary-inverse" | "secondary" | "success" | "danger" | undefined;
         isShowingTooltip?: boolean | undefined;
         mountNode?: import("@instructure/ui-position").PositionMountNode | undefined;
         placement?: import("@instructure/ui-position").PlacementPropValues | undefined;
@@ -42,18 +43,16 @@ declare class ToggleButton extends Component<ToggleButtonProps> {
     static defaultProps: {
         size: string;
         as: string;
-        elementRef: (el: any) => void;
-        renderIcon: () => void;
-        onClick: () => void;
+        interaction: undefined;
         mountNode: null;
         color: string;
         placement: string;
         constrain: string;
     };
-    constructor(props: any);
+    constructor(props: ToggleButtonProps);
     ref: Element | null;
     handleRef: (el: Element | null) => void;
-    get isShowingTooltip(): any;
+    get isShowingTooltip(): boolean;
     render(): JSX.Element;
 }
 export { ToggleButton };

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ToggleButton/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAUxC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD;;;;GAIG;AAEH,cACM,YAAa,SAAQ,SAAS,CAAC,iBAAiB,CAAC;IACrD,MAAM,CAAC,QAAQ,CAAC,WAAW,kBAAiB;IAE5C,MAAM,CAAC,SAAS;;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;;;MAYlB;gBAGW,KAAK,KAAA;IAQjB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,IAAI,gBAAgB,QAKnB;IAED,MAAM;CAqDP;AAED,OAAO,EAAE,YAAY,EAAE,CAAA;AACvB,eAAe,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ToggleButton/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAUxC,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEnE;;;;;GAKG;AAEH,cACM,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;;;;;;;;MASlB;gBAEW,KAAK,EAAE,iBAAiB;IAQpC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,IAAI,gBAAgB,YAInB;IAED,MAAM;CAkDP;AAED,OAAO,EAAE,YAAY,EAAE,CAAA;AACvB,eAAe,YAAY,CAAA"}

package/types/ToggleButton/props.d.ts

@@ -1,27 +1,75 @@
 import React from 'react';
 import type { AsElementType, OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
 import type { PlacementPropValues, PositionConstraint, PositionMountNode } from '@instructure/ui-position';
+import type { ViewProps } from '@instructure/ui-view';
 declare type ToggleButtonOwnProps = {
+    /**
+     * Text to output only to screen readers
+     */
     screenReaderLabel: string;
+    /**
+     * Text to render in the tooltip shown on hover/focus
+     */
     renderTooltipContent: React.ReactNode | ((...args: any[]) => any);
-    renderIcon: React.ReactNode | ((...args: any[]) => any);
+    /**
+     * An icon or function that returns an icon
+     */
+    renderIcon: React.ReactNode | (() => React.ReactNode);
+    /**
+     * Toggles the `aria-pressed` attribute on the button (`true` if `pressed`; `false` if `unpressed`)
+     */
     status: 'pressed' | 'unpressed';
+    /**
+     * The element to render as the component root; `button` by default
+     */
     as?: AsElementType;
+    /**
+     * Specifies if interaction with `ToggleButton` is `enabled`, `disabled`, or `readonly`
+     */
     interaction?: 'enabled' | 'disabled' | 'readonly';
+    /**
+     * The size of the `ToggleButton`
+     */
     size?: 'small' | 'medium' | 'large';
+    /**
+     * Provides a reference to `ToggleButton`'s underlying HTML element
+     */
     elementRef?: (element: Element | null) => void;
-    onClick?: (...args: any[]) => any;
-    color?: string;
+    /**
+     * Callback fired when the `ToggleButton` is clicked
+     */
+    onClick?: (event: React.KeyboardEvent<ViewProps> | React.MouseEvent<ViewProps>) => void;
+    /**
+     * The color in which to display the icon
+     */
+    color?: 'primary' | 'primary-inverse' | 'secondary' | 'success' | 'danger';
+    /**
+     * By default, the tooltip will show on hover/focus. Use this prop if you need to override that behavior.
+     */
     isShowingTooltip?: boolean;
+    /**
+     * An element or a function returning an element to use as the mount node
+     */
     mountNode?: PositionMountNode;
+    /**
+     * The placement of the tooltip in relation to the button
+     */
     placement?: PlacementPropValues;
+    /**
+     * The parent in which to constrain the tooltip.
+     * One of: 'window', 'scroll-parent', 'parent', 'none', an element,
+     * or a function returning an element.
+     */
     constrain?: PositionConstraint;
 };
 declare type PropKeys = keyof ToggleButtonOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
 declare type ToggleButtonProps = ToggleButtonOwnProps & OtherHTMLAttributes<ToggleButtonOwnProps>;
+declare type ToggleButtonState = {
+    isShowingTooltip: boolean;
+};
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { ToggleButtonProps };
+export type { ToggleButtonProps, ToggleButtonState };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/ToggleButton/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AAEjC,aAAK,oBAAoB,GAAG;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,oBAAoB,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACjE,UAAU,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IACvD,MAAM,EAAE,SAAS,GAAG,WAAW,CAAA;IAC/B,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB,WAAW,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAA;IACjD,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAC/B,SAAS,CAAC,EAAE,kBAAkB,CAAA;CAC/B,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,mBAAmB,CAAC,oBAAoB,CAAC,CAAA;AAE3C,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA4DvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAenB,CAAA;AAED,YAAY,EAAE,iBAAiB,EAAE,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/ToggleButton/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAErD,aAAK,oBAAoB,GAAG;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,oBAAoB,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAA;IAEjE;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IAErD;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAA;IAE/B;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,CAAA;IAEjD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAE9C;;OAEG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,KAChE,IAAI,CAAA;IAET;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,iBAAiB,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAA;IAE1E;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAE/B;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAA;CAC/B,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,mBAAmB,CAAC,oBAAoB,CAAC,CAAA;AAE3C,aAAK,iBAAiB,GAAG;IACvB,gBAAgB,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAsBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAenB,CAAA;AAED,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}