@instructure/ui-options 8.19.1-snapshot.8 → 8.20.1-snapshot.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/es/Options/Item/__examples__/Item.examples.js +5 -0
- package/es/Options/Item/index.js +16 -9
- package/es/Options/Item/props.js +3 -2
- package/es/Options/Item/styles.js +18 -1
- package/es/Options/Item/theme.js +1 -1
- package/es/Options/index.js +2 -2
- package/lib/Options/Item/__examples__/Item.examples.js +5 -0
- package/lib/Options/Item/index.js +15 -8
- package/lib/Options/Item/props.js +3 -2
- package/lib/Options/Item/styles.js +18 -1
- package/lib/Options/Item/theme.js +1 -1
- package/lib/Options/index.js +2 -2
- package/package.json +14 -14
- package/src/Options/Item/__examples__/Item.examples.ts +10 -0
- package/src/Options/Item/index.tsx +31 -4
- package/src/Options/Item/props.ts +22 -3
- package/src/Options/Item/styles.ts +17 -1
- package/src/Options/Item/theme.ts +1 -1
- package/src/Options/README.md +61 -0
- package/src/Options/index.tsx +8 -2
- package/tsconfig.build.tsbuildinfo +1 -1
- package/types/Options/Item/__examples__/Item.examples.d.ts.map +1 -1
- package/types/Options/Item/index.d.ts +6 -4
- package/types/Options/Item/index.d.ts.map +1 -1
- package/types/Options/Item/props.d.ts +8 -3
- package/types/Options/Item/props.d.ts.map +1 -1
- package/types/Options/Item/styles.d.ts.map +1 -1
- package/types/Options/index.d.ts.map +1 -1
|
@@ -1 +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,
|
|
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,wBA8DkC"}
|
|
@@ -11,16 +11,16 @@ id: Options.Item
|
|
|
11
11
|
**/
|
|
12
12
|
declare class Item extends Component<OptionsItemProps> {
|
|
13
13
|
static readonly componentId = "Options.Item";
|
|
14
|
-
static allowedProps: readonly ("elementRef" | keyof {
|
|
14
|
+
static allowedProps: readonly ("elementRef" | "href" | keyof {
|
|
15
15
|
children?: import("react").ReactNode | (() => import("react").ReactNode);
|
|
16
16
|
as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
|
|
17
|
-
variant?: "default" | "disabled" | "selected" | "highlighted" | undefined;
|
|
17
|
+
variant?: "default" | "disabled" | "selected" | "highlighted" | "highlighted-disabled" | undefined;
|
|
18
18
|
role?: string | undefined;
|
|
19
19
|
} | "renderBeforeLabel" | "renderAfterLabel" | "beforeLabelContentVAlign" | "afterLabelContentVAlign" | "description" | "descriptionRole")[];
|
|
20
|
-
static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<"elementRef" | keyof {
|
|
20
|
+
static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<"elementRef" | "href" | keyof {
|
|
21
21
|
children?: import("react").ReactNode | (() => import("react").ReactNode);
|
|
22
22
|
as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
|
|
23
|
-
variant?: "default" | "disabled" | "selected" | "highlighted" | undefined;
|
|
23
|
+
variant?: "default" | "disabled" | "selected" | "highlighted" | "highlighted-disabled" | undefined;
|
|
24
24
|
role?: string | undefined;
|
|
25
25
|
} | "renderBeforeLabel" | "renderAfterLabel" | "beforeLabelContentVAlign" | "afterLabelContentVAlign" | "description" | "descriptionRole">;
|
|
26
26
|
static defaultProps: {
|
|
@@ -32,6 +32,8 @@ declare class Item extends Component<OptionsItemProps> {
|
|
|
32
32
|
readonly afterLabelContentVAlign: "center";
|
|
33
33
|
};
|
|
34
34
|
ref: Element | null;
|
|
35
|
+
private readonly _descriptionId;
|
|
36
|
+
constructor(props: OptionsItemProps);
|
|
35
37
|
componentDidMount(): void;
|
|
36
38
|
componentDidUpdate(): void;
|
|
37
39
|
renderContent(renderLabel: OptionsItemProps['renderBeforeLabel'] | OptionsItemProps['renderAfterLabel'], contentVariant: OptionsItemStyle['contentBefore'] | OptionsItemStyle['contentAfter']): jsx.JSX.Element;
|
|
@@ -1 +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;
|
|
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;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"}
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import type { AsElementType, PropValidators, OptionsItemTheme, OtherHTMLAttributes } from '@instructure/shared-types';
|
|
3
|
+
import type { WithDeterministicIdProps } from '@instructure/ui-react-utils';
|
|
3
4
|
import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
|
|
4
5
|
declare type ItemProps = {
|
|
5
6
|
children?: React.ReactNode | (() => React.ReactNode);
|
|
6
7
|
/**
|
|
7
|
-
* Element type to render as
|
|
8
|
+
* Element type to render as. Will be set to `<a>` if href is provided.
|
|
8
9
|
*/
|
|
9
10
|
as?: AsElementType;
|
|
10
11
|
/**
|
|
11
12
|
* The style variant of the item
|
|
12
13
|
*/
|
|
13
|
-
variant?: 'default' | 'highlighted' | 'selected' | 'disabled';
|
|
14
|
+
variant?: 'default' | 'highlighted' | 'selected' | 'disabled' | 'highlighted-disabled';
|
|
14
15
|
/**
|
|
15
16
|
* The ARIA role of the element
|
|
16
17
|
*/
|
|
@@ -43,6 +44,10 @@ declare type OptionsItemOwnProps = ItemProps & {
|
|
|
43
44
|
* The ARIA role of the description element
|
|
44
45
|
*/
|
|
45
46
|
descriptionRole?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Providing href will render the option as `<a>`.
|
|
49
|
+
*/
|
|
50
|
+
href?: string;
|
|
46
51
|
/**
|
|
47
52
|
* provides a reference to the underlying html root element
|
|
48
53
|
*/
|
|
@@ -50,7 +55,7 @@ declare type OptionsItemOwnProps = ItemProps & {
|
|
|
50
55
|
};
|
|
51
56
|
declare type PropKeys = keyof OptionsItemOwnProps;
|
|
52
57
|
declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
|
|
53
|
-
declare type OptionsItemProps = OptionsItemOwnProps & WithStyleProps<OptionsItemTheme, OptionsItemStyle> & OtherHTMLAttributes<OptionsItemOwnProps>;
|
|
58
|
+
declare type OptionsItemProps = OptionsItemOwnProps & WithStyleProps<OptionsItemTheme, OptionsItemStyle> & WithDeterministicIdProps & OtherHTMLAttributes<OptionsItemOwnProps>;
|
|
54
59
|
declare type OptionsItemStyle = ComponentStyle<'item' | 'container' | 'content' | 'contentBefore' | 'contentAfter' | 'description'>;
|
|
55
60
|
declare const propTypes: PropValidators<PropKeys>;
|
|
56
61
|
declare const allowedProps: AllowedPropKeys;
|
|
@@ -1 +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,
|
|
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,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"}
|
|
@@ -1 +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,
|
|
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,gBA4JF,CAAA;AAED,eAAe,aAAa,CAAA"}
|
|
@@ -1 +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;
|
|
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;CAkCP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}
|