@instructure/ui-alerts 8.15.1-snapshot.0 → 8.16.0

package/types/Alert/index.d.ts

@@ -1,41 +1,43 @@
 /** @jsx jsx */
-import { Component } from 'react';
+import React, { Component } from 'react';
+import type { ViewOwnProps } from '@instructure/ui-view';
 import { IconCheckMarkSolid, IconInfoBorderlessSolid, IconWarningBorderlessSolid, IconNoSolid } from '@instructure/ui-icons';
 import { jsx } from '@instructure/emotion';
-import type { AlertProps } from './props';
+import type { AlertProps, AlertState } from './props';
 /**
 ---
 category: components
 ---
+@tsProps
 **/
-declare class Alert extends Component<AlertProps> {
+declare class Alert extends Component<AlertProps, AlertState> {
     static readonly componentId = "Alert";
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
-        children?: import("react").ReactNode;
+        children?: React.ReactNode;
         variant?: "info" | "success" | "warning" | "error" | undefined;
-        liveRegion?: ((...args: any[]) => any) | undefined;
+        liveRegion?: (() => Element) | undefined;
         liveRegionPoliteness?: "polite" | "assertive" | undefined;
         isLiveRegionAtomic?: boolean | undefined;
         screenReaderOnly?: boolean | undefined;
         timeout?: number | undefined;
         margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
-        renderCloseButtonLabel?: import("react").ReactNode | ((...args: any[]) => any);
-        onDismiss?: ((...args: any[]) => any) | undefined;
+        renderCloseButtonLabel?: React.ReactNode | (() => React.ReactNode);
+        onDismiss?: (() => void) | undefined;
         transition?: "none" | "fade" | undefined;
         open?: boolean | undefined;
         hasShadow: boolean;
     }>;
     static allowedProps: readonly (keyof {
-        children?: import("react").ReactNode;
+        children?: React.ReactNode;
         variant?: "info" | "success" | "warning" | "error" | undefined;
-        liveRegion?: ((...args: any[]) => any) | undefined;
+        liveRegion?: (() => Element) | undefined;
         liveRegionPoliteness?: "polite" | "assertive" | undefined;
         isLiveRegionAtomic?: boolean | undefined;
         screenReaderOnly?: boolean | undefined;
         timeout?: number | undefined;
         margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
-        renderCloseButtonLabel?: import("react").ReactNode | ((...args: any[]) => any);
-        onDismiss?: ((...args: any[]) => any) | undefined;
+        renderCloseButtonLabel?: React.ReactNode | (() => React.ReactNode);
+        onDismiss?: (() => void) | undefined;
         transition?: "none" | "fade" | undefined;
         open?: boolean | undefined;
         hasShadow: boolean;
@@ -52,8 +54,9 @@ declare class Alert extends Component<AlertProps> {
         children: null;
         hasShadow: boolean;
     };
-    constructor(props: any);
-    _timeouts: never[];
+    constructor(props: AlertProps);
+    _timeouts: ReturnType<typeof setTimeout>[];
+    srid?: string;
     variantUI: {
         error: typeof IconNoSolid;
         info: typeof IconInfoBorderlessSolid;
@@ -66,17 +69,17 @@ declare class Alert extends Component<AlertProps> {
     clearTimeouts(): void;
     onExitTransition: () => void;
     close: () => void;
-    isDOMNode(n: any): any;
-    getLiveRegion(): any;
-    initLiveRegion(liveRegion: any): void;
+    isDOMNode(n: Element | null): boolean | null;
+    getLiveRegion(): Element | null;
+    initLiveRegion(liveRegion: Element): void;
     createScreenreaderContentNode(): jsx.JSX.Element;
     createScreenreaderAlert(): void;
     updateScreenreaderAlert(): void;
-    renderScreenreeaderAlert(div: any): void;
+    renderScreenreeaderAlert(div: HTMLDivElement): void;
     removeScreenreaderAlert(): void;
-    handleKeyUp: (event: any) => void;
+    handleKeyUp: (event: React.KeyboardEvent<ViewOwnProps>) => void;
     componentDidMount(): void;
-    componentDidUpdate(prevProps: any): void;
+    componentDidUpdate(prevProps: AlertProps): void;
     componentWillUnmount(): void;
     renderIcon(): jsx.JSX.Element;
     renderCloseButton(): jsx.JSX.Element | null;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Alert/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAQjC,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,WAAW,EACZ,MAAM,uBAAuB,CAAA;AAK9B,OAAO,EAAa,GAAG,EAA0B,MAAM,sBAAsB,CAAA;AAM7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEzC;;;;GAIG;AACH,cACM,KAAM,SAAQ,SAAS,CAAC,UAAU,CAAC;IACvC,MAAM,CAAC,QAAQ,CAAC,WAAW,WAAU;IAErC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;;;;MAWlB;gBAGW,KAAK,KAAA;IAQjB,SAAS,UAAK;IAEd,SAAS;;;;;MAKR;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,aAAa,aAUZ;IAED,aAAa;IAKb,gBAAgB,aAIf;IAED,KAAK,aAQJ;IAID,SAAS,CAAC,CAAC,KAAA;IAIX,aAAa;IAUb,cAAc,CAAC,UAAU,KAAA;IAazB,6BAA6B;IAI7B,uBAAuB;IAevB,uBAAuB;IAcvB,wBAAwB,CAAC,GAAG,KAAA;IAW5B,uBAAuB;IAwBvB,WAAW,uBAOV;IAED,iBAAiB;IAajB,kBAAkB,CAAC,SAAS,KAAA;IAc5B,oBAAoB;IAKpB,UAAU;IAUV,iBAAiB;IAgBjB,WAAW;IAgBX,MAAM;CA4BP;AAED,eAAe,KAAK,CAAA;AACpB,OAAO,EAAE,KAAK,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Alert/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOxC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,WAAW,EACZ,MAAM,uBAAuB,CAAA;AAK9B,OAAO,EAAa,GAAG,EAA0B,MAAM,sBAAsB,CAAA;AAM7E,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAErD;;;;;GAKG;AACH,cACM,KAAM,SAAQ,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;IACnD,MAAM,CAAC,QAAQ,CAAC,WAAW,WAAU;IAErC,MAAM,CAAC,SAAS;;;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,YAAY;;;;;;;;;;;MAWlB;gBAEW,KAAK,EAAE,UAAU;IAQ7B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,CAAK;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,SAAS;;;;;MAKR;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,aAAa,aAQZ;IAED,aAAa;IAKb,gBAAgB,aAIf;IAED,KAAK,aAQJ;IAGD,SAAS,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI;IAI3B,aAAa;IASb,cAAc,CAAC,UAAU,EAAE,OAAO;IAgBlC,6BAA6B;IAI7B,uBAAuB;IAavB,uBAAuB;IAWvB,wBAAwB,CAAC,GAAG,EAAE,cAAc;IAW5C,uBAAuB;IAqBvB,WAAW,UAAW,mBAAmB,CAAC,YAAY,CAAC,UAOtD;IAED,iBAAiB;IAWjB,kBAAkB,CAAC,SAAS,EAAE,UAAU;IAaxC,oBAAoB;IAKpB,UAAU;IASV,iBAAiB;IAgBjB,WAAW;IAgBX,MAAM;CA0BP;AAED,eAAe,KAAK,CAAA;AACpB,OAAO,EAAE,KAAK,EAAE,CAAA"}

package/types/Alert/props.d.ts

@@ -2,18 +2,60 @@ import { ReactNode } from 'react';
 import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
 import type { AlertTheme, PropValidators } from '@instructure/shared-types';
 declare type AlertOwnProps = {
+    /**
+     * content to be rendered within Alert
+     */
     children?: ReactNode;
+    /**
+     * Determines color and icon
+     */
     variant?: 'info' | 'success' | 'warning' | 'error';
-    liveRegion?: (...args: any[]) => any;
+    /**
+     * Function that returns the DIV where screenreader alerts will be placed.
+     */
+    liveRegion?: () => Element;
+    /**
+     * Choose the politeness level of screenreader alerts.
+     */
     liveRegionPoliteness?: 'polite' | 'assertive';
+    /**
+     * If the screenreader alert should be atomic
+     */
     isLiveRegionAtomic?: boolean;
+    /**
+     * If the alert should only be visible to screen readers
+     */
     screenReaderOnly?: boolean;
+    /**
+     * Milliseconds until the Alert is dismissed automatically
+     */
     timeout?: number;
+    /**
+     * 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;
-    renderCloseButtonLabel?: ((...args: any[]) => any) | ReactNode;
-    onDismiss?: (...args: any[]) => any;
+    /**
+     * Close button label. Can be a React component
+     */
+    renderCloseButtonLabel?: (() => ReactNode) | ReactNode;
+    /**
+     * Callback after the alert is closed
+     */
+    onDismiss?: () => void;
+    /**
+     * Transition used to make the alert appear and disappear
+     */
     transition?: 'none' | 'fade';
+    /**
+     * if open transitions from truthy to falsey, it's a signal to close and unmount the alert.
+     * This is necessary to close the alert from the outside and still run the transition.
+     */
     open?: boolean;
+    /**
+     * If the alert should have a shadow.
+     */
     hasShadow: boolean;
 };
 declare type PropKeys = keyof AlertOwnProps;
@@ -22,6 +64,9 @@ declare type AlertProps = AlertOwnProps & WithStyleProps<AlertTheme, AlertStyle>
 declare type AlertStyle = ComponentStyle<'alert' | 'icon' | 'closeButton' | 'content'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { AlertProps, AlertStyle };
+declare type AlertState = {
+    open: boolean;
+};
+export type { AlertProps, AlertStyle, AlertState };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Alert/props.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAKjC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE3E,aAAK,aAAa,GAAG;IACnB,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;IAClD,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACpC,oBAAoB,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;IAC7C,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,sBAAsB,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GAAG,SAAS,CAAA;IAC9D,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,SAAS,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,aAAa,CAAA;AAEnC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,UAAU,GAAG,aAAa,GAAG,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;AAExE,aAAK,UAAU,GAAG,cAAc,CAAC,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC,CAAA;AAE9E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAwDvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAcnB,CAAA;AAED,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Alert/props.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAKjC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE3E,aAAK,aAAa,GAAG;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;IAClD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,OAAO,CAAA;IAC1B;;OAEG;IACH,oBAAoB,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;IAC7C;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,sBAAsB,CAAC,EAAE,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS,CAAA;IACtD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC5B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,aAAa,CAAA;AAEnC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,UAAU,GAAG,aAAa,GAAG,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;AAExE,aAAK,UAAU,GAAG,cAAc,CAAC,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC,CAAA;AAE9E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAcvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAcnB,CAAA;AAED,aAAK,UAAU,GAAG;IAChB,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/LICENSE.md

@@ -1,27 +0,0 @@
----
-title: The MIT License (MIT)
-category: Getting Started
-order: 9
----
-
-# The MIT License (MIT)
-
-Copyright (c) 2015 Instructure, Inc.
-
-**Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions.**
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.