@openfin/ui-library 0.23.11 → 0.23.12-alpha.1708023891

package/dist/assets/fonts/index.d.ts

@@ -3,8 +3,4 @@ export declare const Fonts: {
     italic: any;
     semiBold: any;
     semiBoldItalic: any;
-    hanSansJapanese: any;
-    hanSansKorean: any;
-    hanSansChineseSimplified: any;
-    hanSansChineseTraditional: any;
 };

package/dist/components/system/ThemeProvider/lib/constants.d.ts

@@ -150,12 +150,10 @@ export declare const Shadow: {
     base: string;
 };
 /**
- * FontStack --
  * Design System uses "Inter" and we include @font-face definitions to load a CDN hosted version of the font
  * The rest of the stack includes reasonable fallbacks for contingency cases where the CDN asset fails to load
  */
-export declare const FontStack: "Inter, -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen-Sans, Ubuntu, Cantarell, Helvetica Neue, sans-serif";
-export declare const LocalizedFontStack: "HanSansJapanese, HanSansKorean, HanSansChineseSimplified, HanSansChineseTraditional";
+export declare const FontFamily: string;
 /**
  * FontSize --
  * Design System font sizes using standard scale
@@ -188,16 +186,6 @@ export declare const LineHeight: {
     readonly heading: 1.2;
     readonly text: 1.5;
 };
-/**
- * Typography --
- * Design System typography is a full set of values for a `font:...` property.
- * @example "12px/16px Inter, ..."
- * @example "20px/24px Inter, ..."
- */
-export declare const Typography: {
-    readonly base: "12px/1.5 Inter, -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen-Sans, Ubuntu, Cantarell, Helvetica Neue, sans-serif";
-    readonly localize: "12px/1.5 HanSansJapanese, HanSansKorean, HanSansChineseSimplified, HanSansChineseTraditional";
-};
 /**
  * Transitions --
  * Design System transition easings because UI motion feels better if everything moves the same way.
@@ -212,8 +200,6 @@ export declare const Transition: {
  * @link https://icons.modulz.app/
  * @link https://github.com/radix-ui/icons
  *
-
-
  * This exposes them as a named set through OpenFin UI Library
  */
 export declare const IconSet: {
@@ -544,9 +530,3 @@ export declare const IconSize: {
     readonly xxlarge: "32px";
     readonly xxxlarge: "48px";
 };
-/**
- * @font-face --
- * Generate @font-face CSS for CDN Loaded fonts
- */
-export declare const cdnFontFaceCss: import("styled-components").FlattenSimpleInterpolation;
-export declare const cdnLocalizedFontFaceCss: import("styled-components").FlattenSimpleInterpolation;

package/dist/components/system/ThemeProvider/lib/createFontFaceCss.d.ts

@@ -4,10 +4,6 @@ export interface ImportFonts {
     italic?: string;
     semiBold?: string;
     semiBoldItalic?: string;
-    hanSansJapanese?: string;
-    hanSansKorean?: string;
-    hanSansChineseSimplified?: string;
-    hanSansChineseTraditional?: string;
 }
 /**
  * Import global fonts using your own config.

package/dist/components/system/ThemeProvider/lib/createTheme.d.ts

@@ -1,10 +1,9 @@
-import { DefaultTheme } from 'styled-components';
 import { PaletteType } from '../lib/types';
+import { DefaultTheme } from 'styled-components';
 /**
  * Create a theme by accepting an incomplete theme object and deriving the remaining colors based on button colors.
  *
  * @param {Partial<PaletteType>} palettePartial The provided theme keys, whether we or the end user defined them.
- * @param {string} schemeName The name of the scheme to use. Defaults to 'dark'.
  * @returns {DefaultTheme}
  */
-export declare const createTheme: (palettePartial: Partial<PaletteType>, schemeName?: 'light' | 'dark') => DefaultTheme;
+export declare const createTheme: (palettePartial: Partial<PaletteType>) => DefaultTheme;

package/dist/components/system/ThemeProvider/lib/helpers.d.ts

@@ -20,19 +20,16 @@ export declare const getRootCssVars: ({ theme }: {
     theme: DefaultTheme;
 }) => string;
 /**
- * Lazy Load font-faces based on Theme Configuration
+ * Retrive the correct palette value based on the provided status type.
+ * Falls back to optionally provided palette key, then to 'inherit'.
  */
-export declare const getFontFaces: ({ theme }: {
-    theme: DefaultTheme;
-}) => import("styled-components").FlattenSimpleInterpolation;
+export declare const getStatusColor: (theme: DefaultTheme, status?: StatusType, defaultKey?: keyof typeof Palette) => string;
 /**
- * Lazy Load Localized font-faces based on Theme Configuration
+ * A list of languages supported by the OpenFin UI.
  */
-export declare const getLocalizedFontFaces: ({ theme }: {
-    theme: DefaultTheme;
-}) => import("styled-components").FlattenSimpleInterpolation;
+export declare const SUPPORTED_LANGUAGES: readonly ["en-US", "ja-JP", "zh-CN", "ko-KR", "ru-RU", "de-DE", "zh-Hant"];
 /**
- * Retrive the correct palette value based on the provided status type.
- * Falls back to optionally provided palette key, then to 'inherit'.
+ * The type of the supported languages.
+ * @link supportedLanguages
  */
-export declare const getStatusColor: (theme: DefaultTheme, status?: StatusType, defaultKey?: keyof typeof Palette) => string;
+export type Languages = typeof SUPPORTED_LANGUAGES[number];

package/dist/components/system/ThemeProvider/lib/index.d.ts

@@ -1,5 +1,4 @@
 export * from './colors';
-export * from './config';
 export * from './constants';
 export * from './createFontFaceCss';
 export * from './createTheme';

package/dist/components/system/ThemeProvider/lib/interface.d.ts

@@ -1,5 +1,4 @@
-import { Color, FontSize, FontWeight, IconSize, LineHeight, Radius, Shadow, Transition, Unit, UnitPx } from './constants';
-import { ConfigurationType } from './config';
+import { FontFamily, FontSize, FontWeight, IconSize, LineHeight, Radius, Shadow, Transition, Unit, UnitPx } from './constants';
 import { Palette } from './palette';
 declare module 'styled-components' {
     interface DefaultTheme {
@@ -9,8 +8,7 @@ declare module 'styled-components' {
          * - Provides some validation when providing an external theme
          * - Enables auto-completion in styled components.
          */
-        _config: ConfigurationType;
-        _color: typeof Color;
+        fontFamily: typeof FontFamily;
         fontSize: typeof FontSize;
         fontWeight: typeof FontWeight;
         lineHeight: typeof LineHeight;
@@ -21,6 +19,5 @@ declare module 'styled-components' {
         unit: typeof Unit;
         px: typeof UnitPx;
         palette: Record<keyof typeof Palette, string>;
-        selectedScheme: 'light' | 'dark';
     }
 }

package/dist/components/system/ThemeProvider/lib/types.d.ts

@@ -1,9 +1,8 @@
 import { DefaultTheme } from 'styled-components';
-import { Color, FontSize, FontStack, FontWeight, IconSet, IconSize, LineHeight, Radius, Shadow, Size, Transition, Typography, Unit, UnitPx } from './constants';
+import { FontFamily, FontSize, FontWeight, IconSet, IconSize, LineHeight, Radius, Shadow, Size, Transition, Unit, UnitPx } from './constants';
 import { Palette } from './palette';
-export type ColorType = keyof typeof Color;
+export type FontFamilyType = keyof typeof FontFamily;
 export type FontSizeType = keyof typeof FontSize;
-export type FontStackType = keyof typeof FontStack;
 export type FontWeightType = keyof typeof FontWeight;
 export type IconSizeType = keyof typeof IconSize;
 export type IconType = keyof typeof IconSet;
@@ -12,7 +11,6 @@ export type RadiusType = keyof typeof Radius;
 export type ShadowType = keyof typeof Shadow;
 export type SizeType = keyof typeof Size;
 export type TransitionType = keyof typeof Transition;
-export type TypographyType = keyof typeof Typography;
 export type UnitPxType = keyof typeof UnitPx;
 export type UnitType = keyof typeof Unit;
 export type ThemeSet = {
@@ -21,14 +19,6 @@ export type ThemeSet = {
 };
 export type PaletteKeyType = keyof typeof Palette;
 export type PaletteType = Record<keyof typeof Palette, string>;
-export type ThemePaletteSet = {
-    light: {
-        palette: PaletteType;
-    };
-    dark: {
-        palette: PaletteType;
-    };
-};
 /**
  * # Utility Types
  * ========================================================

package/dist/components/system/ThemeProvider/themeProvider.d.ts

@@ -1,13 +1,10 @@
-import { FC, ReactNode } from 'react';
-import { ColorScheme } from '../../../hooks/useColorScheme';
-import { ConfigurationType } from './lib/config';
-import { ThemePaletteSet } from './lib/types';
+import { FC } from 'react';
+import { ColorSchemeType } from '../../../hooks/useColorScheme';
+import { ThemeSet } from './lib/types';
+import { DeepPartial } from '../../../types';
 export type ThemeProviderProps = {
-    children: ReactNode;
-    themes?: ThemePaletteSet;
-    scheme?: keyof typeof ColorScheme;
-    config?: ConfigurationType;
-    includeGlobalStyles?: false;
+    themes?: DeepPartial<ThemeSet>;
+    scheme?: ColorSchemeType;
 };
 /**
  * ## OpenFin ThemeProvider

package/dist/hooks/useColorScheme.d.ts

@@ -5,8 +5,15 @@ export declare const ColorScheme: {
 };
 export type ColorSchemeType = keyof typeof ColorScheme;
 type UseColorSchemeProps = {
-    requestedScheme?: ColorSchemeType;
+    colorScheme?: ColorSchemeType;
     fallbackScheme?: Exclude<ColorSchemeType, 'system'>;
 };
-export declare const useColorScheme: ({ requestedScheme, fallbackScheme, }: UseColorSchemeProps) => "dark" | "light";
+/**
+ * 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/useTheme.d.ts

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