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

package/dist/components/typography/Heading/index.d.ts

@@ -0,0 +1 @@
+export * from './heading';

package/dist/components/typography/Text/index.d.ts

@@ -0,0 +1 @@
+export * from './text';

package/dist/components/typography/Text/text.d.ts

@@ -0,0 +1,21 @@
+import { HTMLAttributes, ReactNode } from 'react';
+import { FontSizeType, FontWeightType } from '../../system/ThemeProvider/lib/types';
+export type TextProps = HTMLAttributes<HTMLElement> & {
+    color?: 'textDefault' | 'background6';
+    children: ReactNode;
+    size?: FontSizeType;
+    weight?: FontWeightType;
+};
+/**
+ * ## Text
+ *
+ * @example <Text>Okay Cool</Text>
+ *          <Text size="small">Okay Cool</Text>
+ *          <Text weight="bold">Okay Cool</Text>
+ */
+export declare const Text: import("styled-components").StyledComponent<"span", import("styled-components").DefaultTheme, HTMLAttributes<HTMLElement> & {
+    color?: "textDefault" | "background6" | undefined;
+    children: ReactNode;
+    size?: "base" | "small" | "xsmall" | "large" | "xlarge" | "xxlarge" | "xxxlarge" | "xxxxlarge" | undefined;
+    weight?: "normal" | "bold" | undefined;
+}, never>;

package/dist/hooks/useColorScheme.d.ts

@@ -0,0 +1,19 @@
+export declare const ColorScheme: {
+    readonly dark: "dark";
+    readonly light: "light";
+    readonly system: "system";
+};
+export type ColorSchemeType = keyof typeof ColorScheme;
+type UseColorSchemeProps = {
+    colorScheme?: ColorSchemeType;
+    fallbackScheme?: Exclude<ColorSchemeType, 'system'>;
+};
+/**
+ * Hook to get the current color scheme.
+ *
+ * @param colorScheme
+ * @param fallbackScheme
+ * @returns the current color scheme
+ */
+export declare const useColorScheme: ({ colorScheme, fallbackScheme, }: UseColorSchemeProps) => Exclude<ColorSchemeType, 'system'>;
+export {};

package/dist/hooks/useDropdownKeyboardNavigation.d.ts

@@ -0,0 +1,16 @@
+import { KeyboardEvent } from 'react';
+import { MenuOption } from '../components/elements/DropdownMenu';
+/**
+ * Hook that handles keyboard navigation and type-to-select functionality of a dropdown menu and returns the focused option.
+ *
+ * @param {MenuOption[][]} options - An array of dropdown options, with each nested array representing a row of options.
+ * @param {MenuOption} selected - The currently selected dropdown option.
+ * @param {boolean} expandMenu - Whether the dropdown menu is expanded or not.
+ * @param {(toggle?: boolean) => void} handleExpandMenu - Function to handle toggling the dropdown menu.
+ * @param {(value: MenuOption) => void} onChange - Function to handle changing the selected option.
+ * @returns {{ focusedOption: MenuOption, handleKeyDown: (event: KeyboardEvent<HTMLDivElement>) => void }} - The currently focused option and a function to handle keydown events.
+ */
+export declare const useDropdownKeyboardNavigation: (options: MenuOption[][], selected: MenuOption | undefined, expandMenu: boolean, handleExpandMenu: (toggle?: boolean) => void, onChange: (value: MenuOption) => void) => {
+    focusedOption: MenuOption | undefined;
+    handleKeyDown: (event: KeyboardEvent<HTMLDivElement>) => void;
+};

package/dist/hooks/useMediaQuery.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ## useMediaQuery
+ * @example   const isPageWide = useMediaQuery('(min-width: 800px)')
+ * @example   const reduceMotion = useMediaQuery('(prefers-reduced-motion: reduce)');
+ */
+export declare const useMediaQuery: (query: string) => boolean;
+/**
+ * ## useLayoutMediaQuery
+ * @example   const isPageWide = useLayoutMediaQuery('(min-width: 800px)')
+ * @example   const reduceMotion = useLayoutMediaQuery('(prefers-reduced-motion: reduce)');
+ */
+export declare const useLayoutMediaQuery: (query: string) => boolean;

package/dist/hooks/usePrevious.d.ts

@@ -0,0 +1 @@
+export declare const usePrevious: <T>(value: T) => T | undefined;

package/dist/hooks/useTheme.d.ts

@@ -0,0 +1,8 @@
+import { DefaultTheme } from 'styled-components';
+import { ColorScheme } from '../hooks/useColorScheme';
+import { ThemeSet } from '../components/system/ThemeProvider';
+import type { DeepPartial } from '../types';
+export declare const useTheme: ({ themes, scheme, }: {
+    themes?: DeepPartial<ThemeSet> | undefined;
+    scheme?: "dark" | "light" | "system" | undefined;
+}) => DefaultTheme;

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+export * from './components/controls/Button';
+export * from './components/controls/CollapsibleCard';
+export * from './components/controls/Menus/CustomContextMenu';
+export * from './components/controls/Menus/ContentMenu';
+export * from './components/controls/ExpandableButton';
+export * from './components/controls/Toggle';
+export * from './components/elements/Badge';
+export * from './components/elements/Calendar';
+export * from './components/elements/DropdownMenu';
+export * from './components/elements/Icon';
+export * from './components/elements/IconWithBadge';
+export * from './components/elements/Loader';
+export * from './components/input/BaseInput';
+export * from './components/input/RawInput';
+export * from './components/input/TextInput';
+export * from './components/input/NumberInput';
+export * from './components/input/Checkbox';
+export * from './components/input/CheckboxGroup';
+export * from './components/input/RadioInput';
+export * from './components/input/RadioGroup';
+export * from './components/input/DateInput';
+export * from './components/input/TextArea';
+export * from './components/layout/Box';
+export * from './components/layout/DefinitionList';
+export * from './components/system';
+export * from './components/templates/ContactCard';
+export * from './components/typography/Heading';
+export * from './components/typography/Text';
+export * from './hooks/useColorScheme';
+export * from './hooks/useMediaQuery';
+export * from './hooks/usePrevious';
+export * from './hooks/useDropdownKeyboardNavigation';
+export * from './lib/whenFin';
+export * from './lib/color-generator';
+export * from './components/helper/ValidationError';
+export * from './assets';