@instructure/ui-alerts 10.18.0 → 10.18.1-snapshot-0

package/types/Alert/index.d.ts

@@ -12,6 +12,7 @@ declare class Alert extends Component<AlertProps, AlertState> {
     static propTypes: import("@instructure/shared-types").PropValidators<keyof {
         children?: import("react").ReactNode;
         variant?: "info" | "success" | "warning" | "error";
+        variantScreenReaderLabel?: string;
         liveRegion?: () => Element;
         liveRegionPoliteness?: "polite" | "assertive";
         isLiveRegionAtomic?: boolean;
@@ -27,6 +28,7 @@ declare class Alert extends Component<AlertProps, AlertState> {
     static allowedProps: readonly (keyof {
         children?: import("react").ReactNode;
         variant?: "info" | "success" | "warning" | "error";
+        variantScreenReaderLabel?: string;
         liveRegion?: () => Element;
         liveRegionPoliteness?: "polite" | "assertive";
         isLiveRegionAtomic?: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Alert/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAY,SAAS,EAAE,MAAM,OAAO,CAAA;AAW3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,WAAW,EACZ,MAAM,uBAAuB,CAAA;AAS9B,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAErD;;;;GAIG;AACH,cAEM,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;IAS7B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,CAAK;IAC/C,IAAI,EAAE,MAAM,CAAA;IAEZ,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,aAWJ;IAGD,SAAS,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI;IAI3B,aAAa;IASb,cAAc,CAAC,UAAU,EAAE,OAAO;IAmBlC,6BAA6B;IAI7B,uBAAuB;IAUvB,uBAAuB;IAkBvB,WAAW,UAAW,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,UAOtD;IAED,iBAAiB;IAUjB,oBAAoB;IAIpB,kBAAkB,CAAC,SAAS,EAAE,UAAU;IASxC,UAAU;IASV,iBAAiB;IAgBjB,WAAW;IAoBX,wBAAwB,CAAC,UAAU,EAAE,OAAO;IAW5C,MAAM;CAsCP;AAED,eAAe,KAAK,CAAA;AACpB,OAAO,EAAE,KAAK,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Alert/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAY,SAAS,EAAE,MAAM,OAAO,CAAA;AAW3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,WAAW,EACZ,MAAM,uBAAuB,CAAA;AAS9B,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAErD;;;;GAIG;AACH,cAEM,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;IAS7B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,CAAK;IAC/C,IAAI,EAAE,MAAM,CAAA;IAEZ,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,aAWJ;IAGD,SAAS,CAAC,CAAC,EAAE,OAAO,GAAG,IAAI;IAI3B,aAAa;IASb,cAAc,CAAC,UAAU,EAAE,OAAO;IAmBlC,6BAA6B;IAQ7B,uBAAuB;IAUvB,uBAAuB;IAkBvB,WAAW,UAAW,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,UAOtD;IAED,iBAAiB;IAUjB,oBAAoB;IAIpB,kBAAkB,CAAC,SAAS,EAAE,UAAU;IASxC,UAAU;IASV,iBAAiB;IAgBjB,WAAW;IAkCX,wBAAwB,CAAC,UAAU,EAAE,OAAO;IAW5C,MAAM;CAsCP;AAED,eAAe,KAAK,CAAA;AACpB,OAAO,EAAE,KAAK,EAAE,CAAA"}

package/types/Alert/props.d.ts

@@ -11,6 +11,10 @@ type AlertOwnProps = {
      * Determines color and icon
      */
     variant?: 'info' | 'success' | 'warning' | 'error';
+    /**
+     * How the screen reader should announce the alert variant. While the `variant` prop sets the color and icon for the alert component, this label should be a textual representation of that information. So e.g. if the variant is `info`, this label could be "Information," or "Information alert,". Note the `,` at the end of the label which helps the screenreader to be more natural sounding.
+     */
+    variantScreenReaderLabel?: string;
     /**
      * Function that returns the DIV where screenreader alerts will be placed.
      */
@@ -74,7 +78,7 @@ type AlertOwnProps = {
 type PropKeys = keyof AlertOwnProps;
 type AllowedPropKeys = Readonly<Array<PropKeys>>;
 type AlertProps = AlertOwnProps & WithStyleProps<AlertTheme, AlertStyle> & WithDeterministicIdProps;
-type AlertStyle = ComponentStyle<'alert' | 'icon' | 'closeButton' | 'content'>;
+type AlertStyle = ComponentStyle<'alert' | 'icon' | 'closeButton' | 'content' | 'variantScreenReaderLabel'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
 type AlertState = {

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;AAGjC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,UAAU,EACX,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAE3E,KAAK,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;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;IAC7C;;;;;OAKG;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,UAAU,CAAA;IACnC;;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,KAAK,QAAQ,GAAG,MAAM,aAAa,CAAA;AAEnC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,UAAU,GAAG,aAAa,GAC7B,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,GACtC,wBAAwB,CAAA;AAE1B,KAAK,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,KAAK,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"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Alert/props.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGjC,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,UAAU,EACX,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAE3E,KAAK,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,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,OAAO,CAAA;IAC1B;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;IAC7C;;;;;OAKG;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,UAAU,CAAA;IACnC;;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,KAAK,QAAQ,GAAG,MAAM,aAAa,CAAA;AAEnC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,UAAU,GAAG,aAAa,GAC7B,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,GACtC,wBAAwB,CAAA;AAE1B,KAAK,UAAU,GAAG,cAAc,CAC9B,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,GAAG,0BAA0B,CAC1E,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAevC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAcnB,CAAA;AAED,KAAK,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/types/Alert/styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/Alert/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAErD;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,mBACD,UAAU,SACnB,UAAU,KAChB,UA8EF,CAAA;AAED,eAAe,aAAa,CAAA"}
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/Alert/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAErD;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,mBACD,UAAU,SACnB,UAAU,KAChB,UAqFF,CAAA;AAED,eAAe,aAAa,CAAA"}