@openfin/ui-library 0.31.3-alpha.20251106171135 → 0.31.3

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 (178) hide show
  1. package/README.md +2 -2
  2. package/dist/assets/fonts/Inter-Italic.woff2 +0 -0
  3. package/dist/assets/fonts/Inter-Regular.woff2 +0 -0
  4. package/dist/assets/fonts/Inter-SemiBold.woff2 +0 -0
  5. package/dist/assets/fonts/Inter-SemiBoldItalic.woff2 +0 -0
  6. package/dist/assets/fonts/index.d.ts +2 -0
  7. package/dist/assets/index.d.ts +1 -0
  8. package/dist/components/controls/Button/button.d.ts +35 -0
  9. package/dist/components/controls/Button/button.variants.d.ts +64 -0
  10. package/dist/components/controls/Button/index.d.ts +2 -0
  11. package/dist/components/controls/ClickableNavigation/clickableNavigation.d.ts +11 -0
  12. package/dist/components/controls/ClickableNavigation/index.d.ts +1 -0
  13. package/dist/components/controls/CollapsibleCard/cardContainer.d.ts +6 -0
  14. package/dist/components/controls/CollapsibleCard/collapsibleCard.d.ts +19 -0
  15. package/dist/components/controls/CollapsibleCard/index.d.ts +1 -0
  16. package/dist/components/controls/ExpandableButton/expandDirection.d.ts +4 -0
  17. package/dist/components/controls/ExpandableButton/expandableButton.d.ts +16 -0
  18. package/dist/components/controls/ExpandableButton/expandablePanel.d.ts +14 -0
  19. package/dist/components/controls/ExpandableButton/expandablePanel.setup.d.ts +2 -0
  20. package/dist/components/controls/ExpandableButton/index.d.ts +2 -0
  21. package/dist/components/controls/Menus/ContentMenu/ContentMenu.d.ts +52 -0
  22. package/dist/components/controls/Menus/ContentMenu/ContentMenuColumn/ContentMenuColumn.d.ts +17 -0
  23. package/dist/components/controls/Menus/ContentMenu/ContentMenuContext.d.ts +5 -0
  24. package/dist/components/controls/Menus/ContentMenu/ContentMenuItem/ContentMenuItem.d.ts +56 -0
  25. package/dist/components/controls/Menus/ContentMenu/ContentMenuItem/IconWithFallback.d.ts +7 -0
  26. package/dist/components/controls/Menus/ContentMenu/ContentMenuItem/useImageLoader.d.ts +8 -0
  27. package/dist/components/controls/Menus/ContentMenu/Tooltip/Tooltip.d.ts +7 -0
  28. package/dist/components/controls/Menus/ContentMenu/index.d.ts +1 -0
  29. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenu.d.ts +96 -0
  30. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenuItems/ColorLinkingContextMenuWidget.d.ts +10 -0
  31. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenuItems/CustomContextMenuItem.d.ts +11 -0
  32. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenuItems/NormalCustomContextMenuItem.d.ts +6 -0
  33. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenuItems/RootMenuHeader.d.ts +5 -0
  34. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenuItems/SeparatorCustomContextMenuItem.d.ts +2 -0
  35. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenuItems/SubmenuHeaderCustomContextMenuItem.d.ts +8 -0
  36. package/dist/components/controls/Menus/CustomContextMenu/CustomContextMenuItems/WidgetCustomContextMenuItem.d.ts +5 -0
  37. package/dist/components/controls/Menus/CustomContextMenu/index.d.ts +1 -0
  38. package/dist/components/controls/Menus/CustomContextMenu/useContextMenuKeyboardNavigation.d.ts +17 -0
  39. package/dist/components/controls/Menus/CustomContextMenu/useContextMenuKeyboardNavigation.test.d.ts +1 -0
  40. package/dist/components/controls/Menus/CustomContextMenu/useContextMenuNavigation.d.ts +25 -0
  41. package/dist/components/controls/Menus/CustomContextMenu/useContextMenuNavigation.test.d.ts +1 -0
  42. package/dist/components/controls/Menus/CustomContextMenu/useResizeContextMenu.d.ts +10 -0
  43. package/dist/components/controls/Menus/CustomContextMenu/useResizeContextMenu.test.d.ts +1 -0
  44. package/dist/components/controls/Menus/CustomContextMenu/utils.d.ts +3 -0
  45. package/dist/components/controls/Menus/common.d.ts +80 -0
  46. package/dist/components/controls/Toggle/index.d.ts +1 -0
  47. package/dist/components/controls/Toggle/toggle.d.ts +10 -0
  48. package/dist/components/elements/Badge/badge.d.ts +18 -0
  49. package/dist/components/elements/Badge/index.d.ts +1 -0
  50. package/dist/components/elements/Calendar/calendar.d.ts +8 -0
  51. package/dist/components/elements/Calendar/index.d.ts +1 -0
  52. package/dist/components/elements/DropdownMenu/dropdownButton.d.ts +15 -0
  53. package/dist/components/elements/DropdownMenu/dropdownMenu.d.ts +16 -0
  54. package/dist/components/elements/DropdownMenu/index.d.ts +3 -0
  55. package/dist/components/elements/DropdownMenu/menu.d.ts +67 -0
  56. package/dist/components/elements/DropdownMenu/optionTitle.d.ts +15 -0
  57. package/dist/components/elements/Icon/icon.d.ts +19 -0
  58. package/dist/components/elements/Icon/icon.variants.d.ts +28 -0
  59. package/dist/components/elements/Icon/index.d.ts +1 -0
  60. package/dist/components/elements/Icon/openfin/BellFilledIcon.d.ts +2 -0
  61. package/dist/components/elements/Icon/openfin/BellIcon.d.ts +6 -0
  62. package/dist/components/elements/Icon/openfin/BlockedIcon.d.ts +2 -0
  63. package/dist/components/elements/Icon/openfin/BookmarkFilled.d.ts +2 -0
  64. package/dist/components/elements/Icon/openfin/BookmarkOutlined.d.ts +2 -0
  65. package/dist/components/elements/Icon/openfin/BrokenLinkIcon.d.ts +2 -0
  66. package/dist/components/elements/Icon/openfin/ChevronDownIcon.d.ts +2 -0
  67. package/dist/components/elements/Icon/openfin/ChevronLeftIcon.d.ts +2 -0
  68. package/dist/components/elements/Icon/openfin/ChevronRightIcon.d.ts +2 -0
  69. package/dist/components/elements/Icon/openfin/ChevronUpIcon.d.ts +2 -0
  70. package/dist/components/elements/Icon/openfin/CollectionIcon.d.ts +2 -0
  71. package/dist/components/elements/Icon/openfin/ContentAppIcon.d.ts +2 -0
  72. package/dist/components/elements/Icon/openfin/EnterpriseGlobeIcon.d.ts +2 -0
  73. package/dist/components/elements/Icon/openfin/ExclamationCircledFilledIcon.d.ts +4 -0
  74. package/dist/components/elements/Icon/openfin/FallbackGlobeIcon.d.ts +2 -0
  75. package/dist/components/elements/Icon/openfin/FilledCircleIcon.d.ts +2 -0
  76. package/dist/components/elements/Icon/openfin/FilterIcon.d.ts +2 -0
  77. package/dist/components/elements/Icon/openfin/FloppyDiskIcon.d.ts +5 -0
  78. package/dist/components/elements/Icon/openfin/FragmentsIcon.d.ts +2 -0
  79. package/dist/components/elements/Icon/openfin/LightBulbFilledIcon.d.ts +2 -0
  80. package/dist/components/elements/Icon/openfin/LightBulbOutlinedIcon.d.ts +2 -0
  81. package/dist/components/elements/Icon/openfin/LockedClosedFilledIcon.d.ts +5 -0
  82. package/dist/components/elements/Icon/openfin/MinimizeIcon.d.ts +5 -0
  83. package/dist/components/elements/Icon/openfin/OpenFinIcon.d.ts +5 -0
  84. package/dist/components/elements/Icon/openfin/PageIcon.d.ts +5 -0
  85. package/dist/components/elements/Icon/openfin/RedDotIcon.d.ts +2 -0
  86. package/dist/components/elements/Icon/openfin/StackIcon.d.ts +2 -0
  87. package/dist/components/elements/Icon/openfin/StorefrontIcon.d.ts +2 -0
  88. package/dist/components/elements/Icon/openfin/SupertabIcon.d.ts +5 -0
  89. package/dist/components/elements/Icon/openfin/WorkspaceIcon.d.ts +5 -0
  90. package/dist/components/elements/Icon/openfin/index.d.ts +30 -0
  91. package/dist/components/elements/IconWithBadge/iconWithBadge.d.ts +5 -0
  92. package/dist/components/elements/IconWithBadge/index.d.ts +1 -0
  93. package/dist/components/elements/Label/label.d.ts +11 -0
  94. package/dist/components/elements/Loader/index.d.ts +2 -0
  95. package/dist/components/elements/Loader/loader.d.ts +4 -0
  96. package/dist/components/elements/Loader/openfinLoader.d.ts +4 -0
  97. package/dist/components/helper/ValidationError.d.ts +6 -0
  98. package/dist/components/input/BaseInput/baseInput.d.ts +29 -0
  99. package/dist/components/input/BaseInput/index.d.ts +1 -0
  100. package/dist/components/input/Checkbox/checkbox.d.ts +12 -0
  101. package/dist/components/input/Checkbox/checkbox.variants.d.ts +21 -0
  102. package/dist/components/input/Checkbox/index.d.ts +1 -0
  103. package/dist/components/input/CheckboxGroup/checkboxGroup.d.ts +15 -0
  104. package/dist/components/input/CheckboxGroup/index.d.ts +1 -0
  105. package/dist/components/input/DateInput/dateInput.d.ts +14 -0
  106. package/dist/components/input/DateInput/index.d.ts +1 -0
  107. package/dist/components/input/NumberInput/index.d.ts +1 -0
  108. package/dist/components/input/NumberInput/numberInput.d.ts +27 -0
  109. package/dist/components/input/RadioGroup/index.d.ts +1 -0
  110. package/dist/components/input/RadioGroup/radioGroup.d.ts +15 -0
  111. package/dist/components/input/RadioInput/index.d.ts +1 -0
  112. package/dist/components/input/RadioInput/radioInput.d.ts +14 -0
  113. package/dist/components/input/RawInput/index.d.ts +1 -0
  114. package/dist/components/input/RawInput/rawInput.d.ts +4 -0
  115. package/dist/components/input/TextArea/index.d.ts +1 -0
  116. package/dist/components/input/TextArea/textArea.d.ts +12 -0
  117. package/dist/components/input/TextInput/index.d.ts +1 -0
  118. package/dist/components/input/TextInput/textInput.d.ts +14 -0
  119. package/dist/components/layout/Box/box.d.ts +41 -0
  120. package/dist/components/layout/Box/index.d.ts +1 -0
  121. package/dist/components/layout/Box/types.d.ts +7 -0
  122. package/dist/components/layout/DefinitionList/definitionList.d.ts +10 -0
  123. package/dist/components/layout/DefinitionList/index.d.ts +1 -0
  124. package/dist/components/layout/HamburgerNavigation/hamburgerNavigation.d.ts +13 -0
  125. package/dist/components/layout/HamburgerNavigation/index.d.ts +2 -0
  126. package/dist/components/layout/HamburgerNavigation/sidebarMenu.d.ts +12 -0
  127. package/dist/components/layout/TabList/index.d.ts +1 -0
  128. package/dist/components/layout/TabList/tab.d.ts +8 -0
  129. package/dist/components/layout/TabList/tabList.d.ts +13 -0
  130. package/dist/components/system/GlobalStyles/globalStyles.d.ts +5 -0
  131. package/dist/components/system/GlobalStyles/globalStyles.spec.d.ts +1 -0
  132. package/dist/components/system/GlobalStyles/index.d.ts +1 -0
  133. package/dist/components/system/HOC/index.d.ts +4 -0
  134. package/dist/components/system/ThemeProvider/index.d.ts +2 -0
  135. package/dist/components/system/ThemeProvider/lib/colors.d.ts +4 -0
  136. package/dist/components/system/ThemeProvider/lib/constants.d.ts +214 -0
  137. package/dist/components/system/ThemeProvider/lib/createFontFaceCss.d.ts +11 -0
  138. package/dist/components/system/ThemeProvider/lib/createTheme.d.ts +9 -0
  139. package/dist/components/system/ThemeProvider/lib/helpers.d.ts +35 -0
  140. package/dist/components/system/ThemeProvider/lib/iconSet.d.ts +355 -0
  141. package/dist/components/system/ThemeProvider/lib/index.d.ts +10 -0
  142. package/dist/components/system/ThemeProvider/lib/interface.d.ts +23 -0
  143. package/dist/components/system/ThemeProvider/lib/mixins.d.ts +16 -0
  144. package/dist/components/system/ThemeProvider/lib/palette.d.ts +42 -0
  145. package/dist/components/system/ThemeProvider/lib/types.d.ts +42 -0
  146. package/dist/components/system/ThemeProvider/theme/index.d.ts +1 -0
  147. package/dist/components/system/ThemeProvider/theme/openfin.d.ts +9 -0
  148. package/dist/components/system/ThemeProvider/themeProvider.d.ts +20 -0
  149. package/dist/components/system/ThemeProvider/themeProvider.spec.d.ts +1 -0
  150. package/dist/components/system/index.d.ts +3 -0
  151. package/dist/components/templates/CascadingDropdownMenu/cascadingDropdownMenu.d.ts +1 -0
  152. package/dist/components/templates/ContactCard/ContactStatusIcon.d.ts +7 -0
  153. package/dist/components/templates/ContactCard/PresenceIcons.d.ts +4 -0
  154. package/dist/components/templates/ContactCard/contactCard.d.ts +30 -0
  155. package/dist/components/templates/ContactCard/index.d.ts +1 -0
  156. package/dist/components/templates/utils/name.d.ts +1 -0
  157. package/dist/components/typography/Heading/heading.d.ts +1668 -0
  158. package/dist/components/typography/Heading/index.d.ts +1 -0
  159. package/dist/components/typography/Text/index.d.ts +1 -0
  160. package/dist/components/typography/Text/text.d.ts +21 -0
  161. package/dist/hooks/useColorScheme.d.ts +19 -0
  162. package/dist/hooks/useDropdownKeyboardNavigation.d.ts +16 -0
  163. package/dist/hooks/useMediaQuery.d.ts +12 -0
  164. package/dist/hooks/usePrevious.d.ts +1 -0
  165. package/dist/hooks/useTheme.d.ts +8 -0
  166. package/dist/index.d.ts +36 -0
  167. package/dist/index.js +1565 -0
  168. package/dist/index.js.LICENSE.txt +19 -0
  169. package/dist/lib/color-generator.d.ts +7 -0
  170. package/dist/lib/color-generator.spec.d.ts +1 -0
  171. package/dist/lib/math.d.ts +13 -0
  172. package/dist/lib/whenFin.d.ts +6 -0
  173. package/dist/lib/whenFin.spec.d.ts +1 -0
  174. package/dist/storybookHelpers.d.ts +78 -0
  175. package/dist/theme.d.ts +3 -0
  176. package/dist/theme.js +1 -0
  177. package/dist/types/index.d.ts +3 -0
  178. package/package.json +46 -12
@@ -0,0 +1,42 @@
1
+ import type { DefaultTheme } from 'styled-components';
2
+ import type { FontFamily, FontSize, FontWeight, IconSize, LineHeight, Radius, Shadow, Size, Transition, Unit, UnitPx } from './constants';
3
+ import { Palette } from './palette';
4
+ import type { IconSet } from './iconSet';
5
+ export type FontFamilyType = keyof typeof FontFamily;
6
+ export type FontSizeType = keyof typeof FontSize;
7
+ export type FontWeightType = keyof typeof FontWeight;
8
+ export type IconSizeType = keyof typeof IconSize;
9
+ export type IconType = keyof typeof IconSet;
10
+ export type LineHeightType = keyof typeof LineHeight;
11
+ export type RadiusType = keyof typeof Radius;
12
+ export type ShadowType = keyof typeof Shadow;
13
+ export type SizeType = keyof typeof Size;
14
+ export type TransitionType = keyof typeof Transition;
15
+ export type UnitPxType = keyof typeof UnitPx;
16
+ export type UnitType = keyof typeof Unit;
17
+ export type ThemeSet = {
18
+ light: DefaultTheme;
19
+ dark: DefaultTheme;
20
+ };
21
+ export type PaletteKeyType = keyof typeof Palette;
22
+ export type PaletteType = Record<keyof typeof Palette, string>;
23
+ /**
24
+ * # Utility Types
25
+ * ========================================================
26
+ */
27
+ /**
28
+ * ## ValueOf Type
29
+ *
30
+ * Convenience for ensure value is in an Object, let built-in `keyof`
31
+ * @example ValueOf<typeof someObject>
32
+ * @link https://stackoverflow.com/questions/49285864/is-there-a-valueof-similar-to-keyof-in-typescript
33
+ */
34
+ export type ValueOf<T> = T[keyof T];
35
+ /**
36
+ * Join a string tuple to a string with a separator.
37
+ * @example
38
+ * const array = ['hello', 'world'] as const;
39
+ * type MyArrayString = StringTupleJoin<typeof array, ', '>;
40
+ * const str: MyArrayString = "hello, world";
41
+ */
42
+ export type StringTupleJoin<T extends readonly string[], Separator extends string> = T extends readonly [string, ...infer Tail] ? Tail extends [string, ...string[]] ? `${T[0]}${Separator}${StringTupleJoin<Tail, Separator>}` : `${T[0]}` : never;
@@ -0,0 +1 @@
1
+ export * from './openfin';
@@ -0,0 +1,9 @@
1
+ import { DefaultTheme } from 'styled-components';
2
+ /**
3
+ * Light Theme
4
+ */
5
+ export declare const OpenFinLightTheme: DefaultTheme;
6
+ /**
7
+ * Dark Theme
8
+ */
9
+ export declare const OpenFinDarkTheme: DefaultTheme;
@@ -0,0 +1,20 @@
1
+ import { FC, ReactNode } from 'react';
2
+ import { ColorSchemeType } from '../../../hooks/useColorScheme';
3
+ import { ThemeSet } from './lib/types';
4
+ import { DeepPartial } from '../../../types';
5
+ import { ImportFonts } from './lib/createFontFaceCss';
6
+ export type ThemeProviderProps = {
7
+ themes?: DeepPartial<ThemeSet>;
8
+ scheme?: ColorSchemeType;
9
+ fonts?: ImportFonts;
10
+ children?: ReactNode;
11
+ };
12
+ /**
13
+ * ## OpenFin ThemeProvider
14
+ * - Extends StyledComponents ThemeProvider
15
+ * - Applies built-in OpenFin themes automatically using System Preference for Color Scheme
16
+ * - Includes global stylesheet with typography, reset, and global css vars
17
+ * - Accepts Light / Dark Mode scheme override
18
+ * - Accepts Light / Dark Mode palette override
19
+ */
20
+ export declare const ThemeProvider: FC<ThemeProviderProps>;
@@ -0,0 +1 @@
1
+ import '@testing-library/jest-dom';
@@ -0,0 +1,3 @@
1
+ export * from './GlobalStyles';
2
+ export * from './HOC';
3
+ export * from './ThemeProvider';
@@ -0,0 +1 @@
1
+ export declare const CascadingDropdownMenu: () => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,7 @@
1
+ import React from 'react';
2
+ import type { ContactCardProps } from './contactCard';
3
+ interface ContactStatusIconProps {
4
+ onlineStatus?: ContactCardProps['onlineStatus'];
5
+ }
6
+ export declare const ContactStatusIcon: React.FC<ContactStatusIconProps>;
7
+ export {};
@@ -0,0 +1,4 @@
1
+ export declare const CheckSVG: () => import("react/jsx-runtime").JSX.Element;
2
+ export declare const BusySVG: () => import("react/jsx-runtime").JSX.Element;
3
+ export declare const DoNotDisturbSVG: () => import("react/jsx-runtime").JSX.Element;
4
+ export declare const OfflineSVG: () => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,30 @@
1
+ import React from 'react';
2
+ export interface ContactCardProps extends React.HTMLAttributes<HTMLDivElement> {
3
+ /**
4
+ * Name of the contact.
5
+ */
6
+ name: string;
7
+ /**
8
+ * Title of the contact.
9
+ */
10
+ title?: string;
11
+ /**
12
+ * URL for the contact's profile photo.
13
+ */
14
+ photoUrl?: string;
15
+ /**
16
+ * A flag to indicate that the contact card should display the contact's initials as profile photo if the photo url is undefined.
17
+ */
18
+ useInitials?: boolean;
19
+ /**
20
+ * An array of detail list objects that can be used for logical grouping of contact details.
21
+ *
22
+ * Passing a Map is deprecated and will be removed in a future release.
23
+ */
24
+ details: Map<string, string>[] | [string, string][][];
25
+ /**
26
+ * The contact's online status.
27
+ */
28
+ onlineStatus?: 'offline' | 'do-not-disturb' | 'busy' | 'away' | 'available';
29
+ }
30
+ export declare const ContactCard: React.FC<ContactCardProps>;
@@ -0,0 +1 @@
1
+ export * from './contactCard';
@@ -0,0 +1 @@
1
+ export declare const getInitials: (name: string) => string;