2020-10-19 09:09:26 +03:00
## API Report File for "@fluentui/style-utilities"
2020-09-12 02:58:47 +03:00
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
2022-03-03 04:13:20 +03:00
import { AnimationStyles } from '@fluentui/theme';
import { AnimationVariables } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { concatStyleSets } from '@fluentui/merge-styles';
import { concatStyleSetsWithProps } from '@fluentui/merge-styles';
2022-03-03 04:13:20 +03:00
import { createFontStyles } from '@fluentui/theme';
import { createTheme } from '@fluentui/theme';
import { DefaultEffects } from '@fluentui/theme';
import { DefaultFontStyles } from '@fluentui/theme';
import { DefaultPalette } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { fontFace } from '@fluentui/merge-styles';
2022-03-03 04:13:20 +03:00
import { FontSizes } from '@fluentui/theme';
import { FontWeights } from '@fluentui/theme';
import { IAnimationStyles } from '@fluentui/theme';
import { IAnimationVariables } from '@fluentui/theme';
import { IconFontSizes } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { ICSPSettings } from '@fluentui/merge-styles';
2021-08-18 20:15:37 +03:00
import type { ICustomizerContext } from '@fluentui/utilities';
2022-03-03 04:13:20 +03:00
import { IEffects } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { IFontFace } from '@fluentui/merge-styles';
2022-03-03 04:13:20 +03:00
import { IFontStyles } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { IFontWeight } from '@fluentui/merge-styles';
import { InjectionMode } from '@fluentui/merge-styles';
2022-03-03 04:13:20 +03:00
import { IPalette } from '@fluentui/theme';
import { IPartialTheme } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { IProcessedStyleSet } from '@fluentui/merge-styles';
import { IRawStyle } from '@fluentui/merge-styles';
2022-03-03 04:13:20 +03:00
import { IScheme } from '@fluentui/theme';
import { ISchemeNames } from '@fluentui/theme';
import { ISemanticColors } from '@fluentui/theme';
import { ISemanticTextColors } from '@fluentui/theme';
import { ISpacing } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { IStyle } from '@fluentui/merge-styles';
import { IStyleSet } from '@fluentui/merge-styles';
2024-03-13 01:50:39 +03:00
import { IStyleSetBase } from '@fluentui/merge-styles';
2020-10-21 05:10:05 +03:00
import { IStyleSheetConfig } from '@fluentui/merge-styles';
2022-03-03 04:13:20 +03:00
import { ITheme } from '@fluentui/theme';
2020-10-21 05:10:05 +03:00
import { keyframes } from '@fluentui/merge-styles';
import { mergeStyles } from '@fluentui/merge-styles';
import { mergeStyleSets } from '@fluentui/merge-styles';
2022-03-03 04:13:20 +03:00
import { registerDefaultFontFaces } from '@fluentui/theme';
2024-04-19 19:22:02 +03:00
import { ShadowConfig } from '@fluentui/merge-styles';
2020-10-21 05:10:05 +03:00
import { Stylesheet } from '@fluentui/merge-styles';
2020-09-12 02:58:47 +03:00
// @public (undocumented)
export const AnimationClassNames: {
[key in keyof IAnimationStyles]?: string;
};
2020-09-24 21:59:56 +03:00
export { AnimationStyles }
2020-09-12 02:58:47 +03:00
2020-09-24 21:59:56 +03:00
export { AnimationVariables }
2020-09-12 02:58:47 +03:00
// @public
export function buildClassMap< T extends Object > (styles: T): {
[key in keyof T]?: string;
};
// Warning: (ae-forgotten-export) The symbol "IColorClassNames" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const ColorClassNames: IColorClassNames;
export { concatStyleSets }
export { concatStyleSetsWithProps }
2020-09-21 23:39:44 +03:00
export { createFontStyles }
2020-09-12 02:58:47 +03:00
2020-09-24 21:08:34 +03:00
export { createTheme }
2020-09-12 02:58:47 +03:00
export { DefaultEffects }
2020-09-21 23:39:44 +03:00
export { DefaultFontStyles }
2020-09-12 02:58:47 +03:00
export { DefaultPalette }
2022-06-06 23:15:39 +03:00
// @public @deprecated (undocumented)
2022-06-27 22:53:22 +03:00
export const EdgeChromiumHighContrastSelector = "@media screen and (-ms-high-contrast: active), screen and (forced-colors: active)";
2020-09-12 02:58:47 +03:00
2023-03-04 02:56:52 +03:00
// @public (undocumented)
2024-11-01 02:42:29 +03:00
export const FLUENT_CDN_BASE_URL = "https://res.cdn.office.net/files/fabric-cdn-prod_20241029.001";
2023-03-04 02:56:52 +03:00
2020-09-12 02:58:47 +03:00
// @public
export function focusClear(): IRawStyle;
// @public (undocumented)
export const FontClassNames: {
[key in keyof IFontStyles]?: string;
};
export { fontFace }
2020-09-21 23:39:44 +03:00
export { FontSizes }
2020-09-12 02:58:47 +03:00
2020-09-21 23:39:44 +03:00
export { FontWeights }
2020-09-12 02:58:47 +03:00
2021-01-28 03:33:21 +03:00
// @public @deprecated
2020-09-12 02:58:47 +03:00
export function getEdgeChromiumNoHighContrastAdjustSelector(): {
[EdgeChromiumHighContrastSelector]: IRawStyle;
};
// @public
export function getFadedOverflowStyle(theme: ITheme, color?: keyof ISemanticColors | keyof IPalette, direction?: 'horizontal' | 'vertical', width?: string | number, height?: string | number): IRawStyle;
// @public
export function getFocusOutlineStyle(theme: ITheme, inset?: number, width?: number, color?: string): IRawStyle;
// @public
export function getFocusStyle(theme: ITheme, options?: IGetFocusStylesOptions): IRawStyle;
// @public @deprecated
2022-08-31 20:52:36 +03:00
export function getFocusStyle(theme: ITheme, inset?: number, position?: 'relative' | 'absolute', highContrastStyle?: IRawStyle | undefined, borderColor?: string, outlineColor?: string, isFocusedOnly?: boolean, borderRadius?: string | number | undefined): IRawStyle;
2020-09-12 02:58:47 +03:00
// @public
export function getGlobalClassNames< T > (classNames: GlobalClassNames< T > , theme: ITheme, disableGlobalClassNames?: boolean): GlobalClassNames< T > ;
2021-01-28 03:33:21 +03:00
// @public
export function getHighContrastNoAdjustStyle(): IRawStyle;
2020-09-12 02:58:47 +03:00
// @public
export function getIcon(name?: string): IIconRecord | undefined;
// @public
export function getIconClassName(name: string): string;
// @public
2021-04-30 05:25:01 +03:00
export const getInputFocusStyle: (borderColor: string, borderRadius: string | number, borderType?: 'border' | 'borderBottom', borderPosition?: number) => IRawStyle;
2020-09-12 02:58:47 +03:00
// @public
export function getPlaceholderStyles(styles: IStyle): IStyle;
// @public (undocumented)
2021-02-19 12:07:51 +03:00
export function getScreenSelector(min: number | undefined, max: number | undefined): string;
2020-09-12 02:58:47 +03:00
// @public
export function getTheme(depComments?: boolean): ITheme;
// Warning: (ae-internal-missing-underscore) The name "getThemedContext" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export function getThemedContext(context: ICustomizerContext, scheme?: ISchemeNames, theme?: ITheme): ICustomizerContext;
// @public (undocumented)
export type GlobalClassNames< IStyles > = Record< keyof IStyles , string > ;
// @public (undocumented)
export const hiddenContentStyle: IRawStyle;
// @public (undocumented)
2022-06-27 22:53:22 +03:00
export const HighContrastSelector = "@media screen and (-ms-high-contrast: active), screen and (forced-colors: active)";
2020-09-12 02:58:47 +03:00
// @public (undocumented)
2022-06-27 22:53:22 +03:00
export const HighContrastSelectorBlack = "@media screen and (-ms-high-contrast: white-on-black), screen and (forced-colors: active) and (prefers-color-scheme: dark)";
2020-09-12 02:58:47 +03:00
// @public (undocumented)
2022-06-27 22:53:22 +03:00
export const HighContrastSelectorWhite = "@media screen and (-ms-high-contrast: black-on-white), screen and (forced-colors: active) and (prefers-color-scheme: light)";
2020-09-12 02:58:47 +03:00
2020-09-24 21:59:56 +03:00
export { IAnimationStyles }
2020-09-12 02:58:47 +03:00
2020-09-24 21:59:56 +03:00
export { IAnimationVariables }
2020-09-12 02:58:47 +03:00
2020-09-21 23:39:44 +03:00
export { IconFontSizes }
2020-09-12 02:58:47 +03:00
export { ICSPSettings }
export { IEffects }
export { IFontFace }
export { IFontStyles }
export { IFontWeight }
// @public (undocumented)
export interface IGetFocusStylesOptions {
borderColor?: string;
2022-08-31 20:52:36 +03:00
borderRadius?: string | number | undefined;
2020-09-12 02:58:47 +03:00
highContrastStyle?: IRawStyle;
inset?: number;
isFocusedOnly?: boolean;
outlineColor?: string;
2023-01-26 14:19:42 +03:00
pointerEvents?: IRawStyle['pointerEvents'];
2020-09-12 02:58:47 +03:00
position?: 'relative' | 'absolute';
width?: number;
}
// @public (undocumented)
export interface IIconOptions {
disableWarnings: boolean;
// @deprecated (undocumented)
warnOnMissingIcons?: boolean;
}
// @public (undocumented)
export interface IIconRecord {
// (undocumented)
code: string | undefined;
// (undocumented)
subset: IIconSubsetRecord;
}
// @public (undocumented)
export interface IIconSubset {
// (undocumented)
fontFace?: IFontFace;
// (undocumented)
icons: {
[key: string]: string | JSX.Element;
};
2021-07-13 00:12:44 +03:00
mergeImageProps?: boolean;
2020-09-12 02:58:47 +03:00
// (undocumented)
style?: IRawStyle;
}
// @public (undocumented)
export interface IIconSubsetRecord extends IIconSubset {
// (undocumented)
className?: string;
// (undocumented)
isRegistered?: boolean;
}
export { InjectionMode }
export { IPalette }
export { IPartialTheme }
export { IProcessedStyleSet }
export { IRawStyle }
export { IScheme }
export { ISchemeNames }
export { ISemanticColors }
export { ISemanticTextColors }
export { ISpacing }
export { IStyle }
export { IStyleSet }
2024-03-13 01:50:39 +03:00
export { IStyleSetBase }
2020-09-12 02:58:47 +03:00
export { IStyleSheetConfig }
export { ITheme }
export { keyframes }
// @public
export function loadTheme(theme: IPartialTheme, depComments?: boolean): ITheme;
export { mergeStyles }
export { mergeStyleSets }
// @public (undocumented)
export const normalize: IRawStyle;
// @public (undocumented)
export const noWrap: IRawStyle;
// @public (undocumented)
export const PulsingBeaconAnimationStyles: {
continuousPulseAnimationDouble: typeof _continuousPulseAnimationDouble;
continuousPulseAnimationSingle: typeof _continuousPulseAnimationSingle;
createDefaultAnimation: typeof _createDefaultAnimation;
};
2020-09-21 23:39:44 +03:00
export { registerDefaultFontFaces }
2020-09-12 02:58:47 +03:00
// @public
export function registerIconAlias(iconName: string, mappedToName: string): void;
// @public
export function registerIcons(iconSubset: IIconSubset, options?: Partial< IIconOptions > ): void;
// @public
export function registerOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
// @public
export function removeOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
// @public (undocumented)
export const ScreenWidthMaxLarge: number;
// @public (undocumented)
export const ScreenWidthMaxMedium: number;
// @public (undocumented)
export const ScreenWidthMaxSmall: number;
// @public (undocumented)
export const ScreenWidthMaxXLarge: number;
// @public (undocumented)
export const ScreenWidthMaxXXLarge: number;
// @public (undocumented)
export const ScreenWidthMinLarge = 640;
// @public (undocumented)
export const ScreenWidthMinMedium = 480;
// @public (undocumented)
export const ScreenWidthMinSmall = 320;
// @public (undocumented)
export const ScreenWidthMinUhfMobile = 768;
// @public (undocumented)
export const ScreenWidthMinXLarge = 1024;
// @public (undocumented)
export const ScreenWidthMinXXLarge = 1366;
// @public (undocumented)
export const ScreenWidthMinXXXLarge = 1920;
// @public
export function setIconOptions(options: Partial< IIconOptions > ): void;
2024-04-19 19:22:02 +03:00
export { ShadowConfig }
2020-09-12 02:58:47 +03:00
export { Stylesheet }
// @public (undocumented)
export const ThemeSettingName = "theme";
// @public
export function unregisterIcons(iconNames: string[]): void;
// @public (undocumented)
export namespace ZIndexes {
const // (undocumented)
Nav: number;
const // @deprecated (undocumented)
ScrollablePane: number;
const // (undocumented)
FocusStyle: number;
const // (undocumented)
Coachmark: number;
const // (undocumented)
Layer: number;
const // (undocumented)
KeytipLayer: number;
}
// Warnings were encountered during analysis:
//
// lib/styles/PulsingBeaconAnimationStyles.d.ts:6:5 - (ae-forgotten-export) The symbol "_continuousPulseAnimationDouble" needs to be exported by the entry point index.d.ts
// lib/styles/PulsingBeaconAnimationStyles.d.ts:7:5 - (ae-forgotten-export) The symbol "_continuousPulseAnimationSingle" needs to be exported by the entry point index.d.ts
// lib/styles/PulsingBeaconAnimationStyles.d.ts:8:5 - (ae-forgotten-export) The symbol "_createDefaultAnimation" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)
```