@instructure/ui-options 8.19.1-snapshot.8 → 8.20.0

package/types/Options/Item/__examples__/Item.examples.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Item.examples.d.ts","sourceRoot":"","sources":["../../../../src/Options/Item/__examples__/Item.examples.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;;AAEhD,wBAoDkC"}
+{"version":3,"file":"Item.examples.d.ts","sourceRoot":"","sources":["../../../../src/Options/Item/__examples__/Item.examples.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;;AAEhD,wBA8DkC"}

package/types/Options/Item/index.d.ts

@@ -11,16 +11,16 @@ id: Options.Item
 **/
 declare class Item extends Component<OptionsItemProps> {
     static readonly componentId = "Options.Item";
-    static allowedProps: readonly ("elementRef" | keyof {
+    static allowedProps: readonly ("elementRef" | "href" | keyof {
         children?: import("react").ReactNode | (() => import("react").ReactNode);
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
-        variant?: "default" | "disabled" | "selected" | "highlighted" | undefined;
+        variant?: "default" | "disabled" | "selected" | "highlighted" | "highlighted-disabled" | undefined;
         role?: string | undefined;
     } | "renderBeforeLabel" | "renderAfterLabel" | "beforeLabelContentVAlign" | "afterLabelContentVAlign" | "description" | "descriptionRole")[];
-    static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<"elementRef" | keyof {
+    static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<"elementRef" | "href" | keyof {
         children?: import("react").ReactNode | (() => import("react").ReactNode);
         as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
-        variant?: "default" | "disabled" | "selected" | "highlighted" | undefined;
+        variant?: "default" | "disabled" | "selected" | "highlighted" | "highlighted-disabled" | undefined;
         role?: string | undefined;
     } | "renderBeforeLabel" | "renderAfterLabel" | "beforeLabelContentVAlign" | "afterLabelContentVAlign" | "description" | "descriptionRole">;
     static defaultProps: {
@@ -32,6 +32,8 @@ declare class Item extends Component<OptionsItemProps> {
         readonly afterLabelContentVAlign: "center";
     };
     ref: Element | null;
+    private readonly _descriptionId;
+    constructor(props: OptionsItemProps);
     componentDidMount(): void;
     componentDidUpdate(): void;
     renderContent(renderLabel: OptionsItemProps['renderBeforeLabel'] | OptionsItemProps['renderAfterLabel'], contentVariant: OptionsItemStyle['contentBefore'] | OptionsItemStyle['contentAfter']): jsx.JSX.Element;

package/types/Options/Item/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AASjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAGjE;;;;;;GAMG;AACH,cAEM,IAAK,SAAQ,SAAS,CAAC,gBAAgB,CAAC;IAC5C,MAAM,CAAC,QAAQ,CAAC,WAAW,kBAAiB;IAE5C,MAAM,CAAC,YAAY;;;;;iJAAe;IAClC,MAAM,CAAC,SAAS;;;;;+IAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;MAOT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,iBAAiB;IAIjB,kBAAkB;IAIlB,aAAa,CACX,WAAW,EACP,gBAAgB,CAAC,mBAAmB,CAAC,GACrC,gBAAgB,CAAC,kBAAkB,CAAC,EACxC,cAAc,EACV,gBAAgB,CAAC,eAAe,CAAC,GACjC,gBAAgB,CAAC,cAAc,CAAC;IAoBtC,MAAM;CA+CP;AAED,eAAe,IAAI,CAAA;AACnB,OAAO,EAAE,IAAI,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAUjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAGjE;;;;;;GAMG;AACH,cAGM,IAAK,SAAQ,SAAS,CAAC,gBAAgB,CAAC;IAC5C,MAAM,CAAC,QAAQ,CAAC,WAAW,kBAAiB;IAE5C,MAAM,CAAC,YAAY;;;;;iJAAe;IAClC,MAAM,CAAC,SAAS;;;;;+IAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;;MAOT;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;gBAE3B,KAAK,EAAE,gBAAgB;IAMnC,iBAAiB;IAIjB,kBAAkB;IAIlB,aAAa,CACX,WAAW,EACP,gBAAgB,CAAC,mBAAmB,CAAC,GACrC,gBAAgB,CAAC,kBAAkB,CAAC,EACxC,cAAc,EACV,gBAAgB,CAAC,eAAe,CAAC,GACjC,gBAAgB,CAAC,cAAc,CAAC;IAoBtC,MAAM;CAgEP;AAED,eAAe,IAAI,CAAA;AACnB,OAAO,EAAE,IAAI,EAAE,CAAA"}

package/types/Options/Item/props.d.ts

@@ -1,16 +1,17 @@
 import React from 'react';
 import type { AsElementType, PropValidators, OptionsItemTheme, OtherHTMLAttributes } from '@instructure/shared-types';
+import type { WithDeterministicIdProps } from '@instructure/ui-react-utils';
 import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
 declare type ItemProps = {
     children?: React.ReactNode | (() => React.ReactNode);
     /**
-     * Element type to render as
+     * Element type to render as. Will be set to `<a>` if href is provided.
      */
     as?: AsElementType;
     /**
      * The style variant of the item
      */
-    variant?: 'default' | 'highlighted' | 'selected' | 'disabled';
+    variant?: 'default' | 'highlighted' | 'selected' | 'disabled' | 'highlighted-disabled';
     /**
      * The ARIA role of the element
      */
@@ -43,6 +44,10 @@ declare type OptionsItemOwnProps = ItemProps & {
      * The ARIA role of the description element
      */
     descriptionRole?: string;
+    /**
+     * Providing href will render the option as `<a>`.
+     */
+    href?: string;
     /**
      * provides a reference to the underlying html root element
      */
@@ -50,7 +55,7 @@ declare type OptionsItemOwnProps = ItemProps & {
 };
 declare type PropKeys = keyof OptionsItemOwnProps;
 declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
-declare type OptionsItemProps = OptionsItemOwnProps & WithStyleProps<OptionsItemTheme, OptionsItemStyle> & OtherHTMLAttributes<OptionsItemOwnProps>;
+declare type OptionsItemProps = OptionsItemOwnProps & WithStyleProps<OptionsItemTheme, OptionsItemStyle> & WithDeterministicIdProps & OtherHTMLAttributes<OptionsItemOwnProps>;
 declare type OptionsItemStyle = ComponentStyle<'item' | 'container' | 'content' | 'contentBefore' | 'contentAfter' | 'description'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;

package/types/Options/Item/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,SAAS,GAAG;IACf,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,UAAU,GAAG,UAAU,CAAA;IAC7D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,aAAK,mBAAmB,GAAG,SAAS,GAAG;IACrC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAC7E;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAC5E;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAA;IACrD;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAA;IACpD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACvD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,mBAAmB,CAAA;AAEzC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,gBAAgB,GAAG,mBAAmB,GACzC,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,GAClD,mBAAmB,CAAC,mBAAmB,CAAC,CAAA;AAE1C,aAAK,gBAAgB,GAAG,cAAc,CAClC,MAAM,GACN,WAAW,GACX,SAAS,GACT,eAAe,GACf,cAAc,GACd,aAAa,CAChB,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAYvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAYnB,CAAA;AAED,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,aAAK,SAAS,GAAG;IACf,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EACJ,SAAS,GACT,aAAa,GACb,UAAU,GACV,UAAU,GACV,sBAAsB,CAAA;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,aAAK,mBAAmB,GAAG,SAAS,GAAG;IACrC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAC7E;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC,CAAA;IAC5E;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAA;IACrD;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAA;IACpD;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACvD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,mBAAmB,CAAA;AAEzC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,gBAAgB,GAAG,mBAAmB,GACzC,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,GAClD,wBAAwB,GACxB,mBAAmB,CAAC,mBAAmB,CAAC,CAAA;AAE1C,aAAK,gBAAgB,GAAG,cAAc,CAClC,MAAM,GACN,WAAW,GACX,SAAS,GACT,eAAe,GACf,cAAc,GACd,aAAa,CAChB,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAmBvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAanB,CAAA;AAED,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/Options/Item/styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/styles.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAEjE;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,mBACD,gBAAgB,SACzB,gBAAgB,KACtB,gBA4IF,CAAA;AAED,eAAe,aAAa,CAAA"}
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/styles.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAEjE;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,mBACD,gBAAgB,SACzB,gBAAgB,KACtB,gBA4JF,CAAA;AAED,eAAe,aAAa,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Options/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAY,MAAM,OAAO,CAAA;AAalD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAKrD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAK3C,aAAK,YAAY,GAAG,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;AAGjE;;;;;GAKG;AACH,cAGM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,YAAY;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,SAAS,mBAAY;IAE5B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAGlB,QAAQ,SAA+C;IAEvD,IAAI,OAAO,qBAMV;IAED,WAAW;IAcX,aAAa,CAAC,UAAU,EAAE,YAAY;IAStC,cAAc;IAcd,MAAM;CA4BP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Options/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAY,MAAM,OAAO,CAAA;AAalD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAKrD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAK3C,aAAK,YAAY,GAAG,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;AAGjE;;;;;GAKG;AACH,cAGM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IAEvC,MAAM,CAAC,YAAY;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,MAAM,CAAC,IAAI,cAAO;IAClB,MAAM,CAAC,SAAS,mBAAY;IAE5B,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAGlB,QAAQ,SAA+C;IAEvD,IAAI,OAAO,qBAMV;IAED,WAAW;IAcX,aAAa,CAAC,UAAU,EAAE,YAAY;IAStC,cAAc;IAcd,MAAM;CAkCP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,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.