UNPKG

11 kBMarkdownView Raw
1## API Report File for "@uifabric/styling"
2
3> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
5```ts
6
7import { AnimationStyles } from '@fluentui/theme/lib/motion/AnimationStyles';
8import { AnimationVariables } from '@fluentui/theme/lib/motion/AnimationStyles';
9import { concatStyleSets } from '@uifabric/merge-styles';
10import { concatStyleSetsWithProps } from '@uifabric/merge-styles';
11import { createFontStyles } from '@fluentui/theme/lib/fonts/index';
12import { createTheme } from '@fluentui/theme/lib/createTheme';
13import { DefaultEffects } from '@fluentui/theme/lib/effects/DefaultEffects';
14import { DefaultFontStyles } from '@fluentui/theme/lib/fonts/DefaultFontStyles';
15import { DefaultPalette } from '@fluentui/theme/lib/colors/DefaultPalette';
16import { fontFace } from '@uifabric/merge-styles';
17import { FontSizes } from '@fluentui/theme/lib/fonts/index';
18import { FontWeights } from '@fluentui/theme/lib/fonts/index';
19import { IAnimationStyles } from '@fluentui/theme/lib/types/IAnimationStyles';
20import { IAnimationVariables } from '@fluentui/theme/lib/types/IAnimationStyles';
21import { IconFontSizes } from '@fluentui/theme/lib/fonts/index';
22import { ICSPSettings } from '@uifabric/merge-styles';
23import { ICustomizerContext } from '@uifabric/utilities';
24import { IEffects } from '@fluentui/theme/lib/types/IEffects';
25import { IFontFace } from '@uifabric/merge-styles';
26import { IFontStyles } from '@fluentui/theme/lib/types/IFontStyles';
27import { IFontWeight } from '@uifabric/merge-styles';
28import { InjectionMode } from '@uifabric/merge-styles';
29import { IPalette } from '@fluentui/theme/lib/types/IPalette';
30import { IPartialTheme } from '@fluentui/theme/lib/types/ITheme';
31import { IProcessedStyleSet } from '@uifabric/merge-styles';
32import { IRawStyle } from '@uifabric/merge-styles';
33import { IScheme } from '@fluentui/theme/lib/types/ITheme';
34import { ISchemeNames } from '@fluentui/theme/lib/types/ITheme';
35import { ISemanticColors } from '@fluentui/theme/lib/types/ISemanticColors';
36import { ISemanticTextColors } from '@fluentui/theme/lib/types/ISemanticTextColors';
37import { ISpacing } from '@fluentui/theme/lib/types/ISpacing';
38import { IStyle } from '@uifabric/merge-styles';
39import { IStyleSet } from '@uifabric/merge-styles';
40import { IStyleSheetConfig } from '@uifabric/merge-styles';
41import { ITheme } from '@fluentui/theme/lib/types/ITheme';
42import { keyframes } from '@uifabric/merge-styles';
43import { mergeStyles } from '@uifabric/merge-styles';
44import { mergeStyleSets } from '@uifabric/merge-styles';
45import { registerDefaultFontFaces } from '@fluentui/theme/lib/fonts/DefaultFontStyles';
46import { Stylesheet } from '@uifabric/merge-styles';
47
48// @public (undocumented)
49export const AnimationClassNames: {
50 [key in keyof IAnimationStyles]?: string;
51};
52
53export { AnimationStyles }
54
55export { AnimationVariables }
56
57// @public
58export function buildClassMap<T extends Object>(styles: T): {
59 [key in keyof T]?: string;
60};
61
62// Warning: (ae-forgotten-export) The symbol "IColorClassNames" needs to be exported by the entry point index.d.ts
63//
64// @public (undocumented)
65export const ColorClassNames: IColorClassNames;
66
67export { concatStyleSets }
68
69export { concatStyleSetsWithProps }
70
71export { createFontStyles }
72
73export { createTheme }
74
75export { DefaultEffects }
76
77export { DefaultFontStyles }
78
79export { DefaultPalette }
80
81// @public (undocumented)
82export const EdgeChromiumHighContrastSelector = "@media screen and (forced-colors: active)";
83
84// @public
85export function focusClear(): IRawStyle;
86
87// @public (undocumented)
88export const FontClassNames: {
89 [key in keyof IFontStyles]?: string;
90};
91
92export { fontFace }
93
94export { FontSizes }
95
96export { FontWeights }
97
98// @public @deprecated
99export function getEdgeChromiumNoHighContrastAdjustSelector(): {
100 [EdgeChromiumHighContrastSelector]: IRawStyle;
101};
102
103// @public
104export function getFadedOverflowStyle(theme: ITheme, color?: keyof ISemanticColors | keyof IPalette, direction?: 'horizontal' | 'vertical', width?: string | number, height?: string | number): IRawStyle;
105
106// @public
107export function getFocusOutlineStyle(theme: ITheme, inset?: number, width?: number, color?: string): IRawStyle;
108
109// @public
110export function getFocusStyle(theme: ITheme, options?: IGetFocusStylesOptions): IRawStyle;
111
112// @public @deprecated
113export function getFocusStyle(theme: ITheme, inset?: number, position?: 'relative' | 'absolute', highContrastStyle?: IRawStyle | undefined, borderColor?: string, outlineColor?: string, isFocusedOnly?: boolean): IRawStyle;
114
115// @public
116export function getGlobalClassNames<T>(classNames: GlobalClassNames<T>, theme: ITheme, disableGlobalClassNames?: boolean): GlobalClassNames<T>;
117
118// @public
119export function getHighContrastNoAdjustStyle(): IRawStyle;
120
121// @public
122export function getIcon(name?: string): IIconRecord | undefined;
123
124// @public
125export function getIconClassName(name: string): string;
126
127// @public
128export const getInputFocusStyle: (borderColor: string, borderRadius: string | number, borderType?: "border" | "borderBottom", borderPosition?: number) => IRawStyle;
129
130// @public
131export function getPlaceholderStyles(styles: IStyle): IStyle;
132
133// @public (undocumented)
134export function getScreenSelector(min: number | undefined, max: number | undefined): string;
135
136// @public
137export function getTheme(depComments?: boolean): ITheme;
138
139// Warning: (ae-internal-missing-underscore) The name "getThemedContext" should be prefixed with an underscore because the declaration is marked as @internal
140//
141// @internal
142export function getThemedContext(context: ICustomizerContext, scheme?: ISchemeNames, theme?: ITheme): ICustomizerContext;
143
144// @public (undocumented)
145export type GlobalClassNames<IStyles> = Record<keyof IStyles, string>;
146
147// @public (undocumented)
148export const hiddenContentStyle: IRawStyle;
149
150// @public (undocumented)
151export const HighContrastSelector = "@media screen and (-ms-high-contrast: active), (forced-colors: active)";
152
153// @public (undocumented)
154export const HighContrastSelectorBlack = "@media screen and (-ms-high-contrast: white-on-black), (forced-colors: white-on-black)";
155
156// @public (undocumented)
157export const HighContrastSelectorWhite = "@media screen and (-ms-high-contrast: black-on-white), (forced-colors: black-on-white)";
158
159export { IAnimationStyles }
160
161export { IAnimationVariables }
162
163export { IconFontSizes }
164
165export { ICSPSettings }
166
167export { IEffects }
168
169export { IFontFace }
170
171export { IFontStyles }
172
173export { IFontWeight }
174
175// @public (undocumented)
176export interface IGetFocusStylesOptions {
177 borderColor?: string;
178 highContrastStyle?: IRawStyle;
179 inset?: number;
180 isFocusedOnly?: boolean;
181 outlineColor?: string;
182 position?: 'relative' | 'absolute';
183 width?: number;
184}
185
186// @public (undocumented)
187export interface IIconOptions {
188 disableWarnings: boolean;
189 // @deprecated (undocumented)
190 warnOnMissingIcons?: boolean;
191}
192
193// @public (undocumented)
194export interface IIconRecord {
195 // (undocumented)
196 code: string | undefined;
197 // (undocumented)
198 subset: IIconSubsetRecord;
199}
200
201// @public (undocumented)
202export interface IIconSubset {
203 // (undocumented)
204 fontFace?: IFontFace;
205 // (undocumented)
206 icons: {
207 [key: string]: string | JSX.Element;
208 };
209 mergeImageProps?: boolean;
210 // (undocumented)
211 style?: IRawStyle;
212}
213
214// @public (undocumented)
215export interface IIconSubsetRecord extends IIconSubset {
216 // (undocumented)
217 className?: string;
218 // (undocumented)
219 isRegistered?: boolean;
220}
221
222export { InjectionMode }
223
224export { IPalette }
225
226export { IPartialTheme }
227
228export { IProcessedStyleSet }
229
230export { IRawStyle }
231
232export { IScheme }
233
234export { ISchemeNames }
235
236export { ISemanticColors }
237
238export { ISemanticTextColors }
239
240export { ISpacing }
241
242export { IStyle }
243
244export { IStyleSet }
245
246export { IStyleSheetConfig }
247
248export { ITheme }
249
250export { keyframes }
251
252// @public
253export function loadTheme(theme: IPartialTheme, depComments?: boolean): ITheme;
254
255export { mergeStyles }
256
257export { mergeStyleSets }
258
259// @public (undocumented)
260export const normalize: IRawStyle;
261
262// @public (undocumented)
263export const noWrap: IRawStyle;
264
265// @public (undocumented)
266export const PulsingBeaconAnimationStyles: {
267 continuousPulseAnimationDouble: typeof _continuousPulseAnimationDouble;
268 continuousPulseAnimationSingle: typeof _continuousPulseAnimationSingle;
269 createDefaultAnimation: typeof _createDefaultAnimation;
270};
271
272export { registerDefaultFontFaces }
273
274// @public
275export function registerIconAlias(iconName: string, mappedToName: string): void;
276
277// @public
278export function registerIcons(iconSubset: IIconSubset, options?: Partial<IIconOptions>): void;
279
280// @public
281export function registerOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
282
283// @public
284export function removeOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
285
286// @public (undocumented)
287export const ScreenWidthMaxLarge: number;
288
289// @public (undocumented)
290export const ScreenWidthMaxMedium: number;
291
292// @public (undocumented)
293export const ScreenWidthMaxSmall: number;
294
295// @public (undocumented)
296export const ScreenWidthMaxXLarge: number;
297
298// @public (undocumented)
299export const ScreenWidthMaxXXLarge: number;
300
301// @public (undocumented)
302export const ScreenWidthMinLarge = 640;
303
304// @public (undocumented)
305export const ScreenWidthMinMedium = 480;
306
307// @public (undocumented)
308export const ScreenWidthMinSmall = 320;
309
310// @public (undocumented)
311export const ScreenWidthMinUhfMobile = 768;
312
313// @public (undocumented)
314export const ScreenWidthMinXLarge = 1024;
315
316// @public (undocumented)
317export const ScreenWidthMinXXLarge = 1366;
318
319// @public (undocumented)
320export const ScreenWidthMinXXXLarge = 1920;
321
322// @public
323export function setIconOptions(options: Partial<IIconOptions>): void;
324
325export { Stylesheet }
326
327// @public (undocumented)
328export const ThemeSettingName = "theme";
329
330// @public
331export function unregisterIcons(iconNames: string[]): void;
332
333// @public (undocumented)
334export namespace ZIndexes {
335 const // (undocumented)
336 Nav: number;
337 const // @deprecated (undocumented)
338 ScrollablePane: number;
339 const // (undocumented)
340 FocusStyle: number;
341 const // (undocumented)
342 Coachmark: number;
343 const // (undocumented)
344 Layer: number;
345 const // (undocumented)
346 KeytipLayer: number;
347}
348
349
350// Warnings were encountered during analysis:
351//
352// lib/styles/PulsingBeaconAnimationStyles.d.ts:6:5 - (ae-forgotten-export) The symbol "_continuousPulseAnimationDouble" needs to be exported by the entry point index.d.ts
353// lib/styles/PulsingBeaconAnimationStyles.d.ts:7:5 - (ae-forgotten-export) The symbol "_continuousPulseAnimationSingle" needs to be exported by the entry point index.d.ts
354// lib/styles/PulsingBeaconAnimationStyles.d.ts:8:5 - (ae-forgotten-export) The symbol "_createDefaultAnimation" needs to be exported by the entry point index.d.ts
355
356// (No @packageDocumentation comment for this package)
357
358```