@instructure/ui-options 8.19.0 → 8.19.1-snapshot.4

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.
Files changed (37) hide show
  1. package/LICENSE.md +27 -0
  2. package/es/Options/Item/index.js +5 -0
  3. package/es/Options/Item/props.js +2 -1
  4. package/es/Options/Item/styles.js +1 -0
  5. package/es/Options/Item/theme.js +1 -0
  6. package/es/Options/Separator/theme.js +1 -0
  7. package/es/Options/theme.js +5 -2
  8. package/es/index.js +4 -1
  9. package/lib/Options/Item/index.js +5 -0
  10. package/lib/Options/Item/props.js +2 -1
  11. package/lib/Options/Item/styles.js +1 -0
  12. package/lib/Options/Item/theme.js +2 -1
  13. package/lib/Options/Separator/theme.js +2 -1
  14. package/lib/Options/theme.js +8 -3
  15. package/lib/index.js +31 -1
  16. package/package.json +15 -14
  17. package/src/Options/Item/index.tsx +6 -1
  18. package/src/Options/Item/props.ts +6 -0
  19. package/src/Options/Item/styles.ts +1 -0
  20. package/src/Options/Item/theme.ts +1 -0
  21. package/src/Options/Separator/theme.ts +1 -0
  22. package/src/Options/theme.ts +11 -1
  23. package/src/index.ts +4 -0
  24. package/tsconfig.build.tsbuildinfo +1 -1
  25. package/types/Options/Item/index.d.ts +2 -2
  26. package/types/Options/Item/index.d.ts.map +1 -1
  27. package/types/Options/Item/props.d.ts +4 -0
  28. package/types/Options/Item/props.d.ts.map +1 -1
  29. package/types/Options/Item/styles.d.ts.map +1 -1
  30. package/types/Options/Item/theme.d.ts +1 -0
  31. package/types/Options/Item/theme.d.ts.map +1 -1
  32. package/types/Options/Separator/theme.d.ts +1 -0
  33. package/types/Options/Separator/theme.d.ts.map +1 -1
  34. package/types/Options/theme.d.ts +3 -1
  35. package/types/Options/theme.d.ts.map +1 -1
  36. package/types/index.d.ts +3 -0
  37. package/types/index.d.ts.map +1 -1
@@ -11,13 +11,13 @@ id: Options.Item
11
11
  **/
12
12
  declare class Item extends Component<OptionsItemProps> {
13
13
  static readonly componentId = "Options.Item";
14
- static allowedProps: readonly (keyof {
14
+ static allowedProps: readonly ("elementRef" | keyof {
15
15
  children?: import("react").ReactNode | (() => import("react").ReactNode);
16
16
  as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
17
17
  variant?: "default" | "disabled" | "selected" | "highlighted" | undefined;
18
18
  role?: string | undefined;
19
19
  } | "renderBeforeLabel" | "renderAfterLabel" | "beforeLabelContentVAlign" | "afterLabelContentVAlign" | "description" | "descriptionRole")[];
20
- static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
20
+ static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<"elementRef" | keyof {
21
21
  children?: import("react").ReactNode | (() => import("react").ReactNode);
22
22
  as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
23
23
  variant?: "default" | "disabled" | "selected" | "highlighted" | undefined;
@@ -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;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;CA0CP;AAED,eAAe,IAAI,CAAA;AACnB,OAAO,EAAE,IAAI,EAAE,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;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"}
@@ -43,6 +43,10 @@ declare type OptionsItemOwnProps = ItemProps & {
43
43
  * The ARIA role of the description element
44
44
  */
45
45
  descriptionRole?: string;
46
+ /**
47
+ * provides a reference to the underlying html root element
48
+ */
49
+ elementRef?: (element: Element | null) => void;
46
50
  };
47
51
  declare type PropKeys = keyof OptionsItemOwnProps;
48
52
  declare type AllowedPropKeys = Readonly<Array<PropKeys>>;
@@ -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,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;CACzB,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,CAWvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAWnB,CAAA;AAED,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
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"}
@@ -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,gBA2IF,CAAA;AAED,eAAe,aAAa,CAAA"}
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"}
@@ -6,5 +6,6 @@ import { OptionsItemTheme } from '@instructure/shared-types';
6
6
  * @return {Object} The final theme object with the overrides and component variables
7
7
  */
8
8
  declare const generateComponentTheme: (theme: Theme) => OptionsItemTheme;
9
+ export { generateComponentTheme as optionsItemThemeGenerator };
9
10
  export default generateComponentTheme;
10
11
  //# sourceMappingURL=theme.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAsB,MAAM,wBAAwB,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAE5D;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,gBAyC9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}
1
+ {"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/Options/Item/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAsB,MAAM,wBAAwB,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAE5D;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,gBAyC9C,CAAA;AAED,OAAO,EAAE,sBAAsB,IAAI,yBAAyB,EAAE,CAAA;AAC9D,eAAe,sBAAsB,CAAA"}
@@ -6,5 +6,6 @@ import { OptionsSeparatorTheme } from '@instructure/shared-types';
6
6
  * @return {Object} The final theme object with the overrides and component variables
7
7
  */
8
8
  declare const generateComponentTheme: (theme: Theme) => OptionsSeparatorTheme;
9
+ export { generateComponentTheme as optionsSeparatorThemeGenerator };
9
10
  export default generateComponentTheme;
10
11
  //# sourceMappingURL=theme.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/Options/Separator/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAEjE;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,qBAY9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}
1
+ {"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/Options/Separator/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAEjE;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,qBAY9C,CAAA;AAED,OAAO,EAAE,sBAAsB,IAAI,8BAA8B,EAAE,CAAA;AACnE,eAAe,sBAAsB,CAAA"}
@@ -1,10 +1,12 @@
1
1
  import type { Theme } from '@instructure/ui-themes';
2
- import { OptionsTheme } from '@instructure/shared-types';
2
+ import type { OptionsTheme } from '@instructure/shared-types';
3
+ declare const optionsThemeKeys: (keyof OptionsTheme)[];
3
4
  /**
4
5
  * Generates the theme object for the component from the theme and provided additional information
5
6
  * @param {Object} theme The actual theme object.
6
7
  * @return {Object} The final theme object with the overrides and component variables
7
8
  */
8
9
  declare const generateComponentTheme: (theme: Theme) => OptionsTheme;
10
+ export { generateComponentTheme as optionsThemeGenerator, optionsThemeKeys };
9
11
  export default generateComponentTheme;
10
12
  //# sourceMappingURL=theme.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/Options/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAExD;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,YAgB9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}
1
+ {"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/Options/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAE7D,QAAA,MAAM,gBAAgB,EAAE,CAAC,MAAM,YAAY,CAAC,EAM3C,CAAA;AAED;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,YAiB9C,CAAA;AAED,OAAO,EAAE,sBAAsB,IAAI,qBAAqB,EAAE,gBAAgB,EAAE,CAAA;AAC5E,eAAe,sBAAsB,CAAA"}
package/types/index.d.ts CHANGED
@@ -1,4 +1,7 @@
1
1
  export { Options } from './Options';
2
+ export { optionsThemeGenerator, optionsThemeKeys } from './Options/theme';
3
+ export { optionsItemThemeGenerator } from './Options/Item/theme';
4
+ export { optionsSeparatorThemeGenerator } from './Options/Separator/theme';
2
5
  export type { OptionsProps } from './Options/props';
3
6
  export type { OptionsItemProps } from './Options/Item/props';
4
7
  export type { OptionsSeparatorProps } from './Options/Separator/props';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,YAAY,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,YAAY,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACzE,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAA;AAChE,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAA;AAE1E,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,YAAY,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,YAAY,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA"}