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 |
|
7 | import { AnimationStyles } from '@fluentui/theme/lib/motion/AnimationStyles';
|
8 | import { AnimationVariables } from '@fluentui/theme/lib/motion/AnimationStyles';
|
9 | import { concatStyleSets } from '@uifabric/merge-styles';
|
10 | import { concatStyleSetsWithProps } from '@uifabric/merge-styles';
|
11 | import { createFontStyles } from '@fluentui/theme/lib/fonts/index';
|
12 | import { createTheme } from '@fluentui/theme/lib/createTheme';
|
13 | import { DefaultEffects } from '@fluentui/theme/lib/effects/DefaultEffects';
|
14 | import { DefaultFontStyles } from '@fluentui/theme/lib/fonts/DefaultFontStyles';
|
15 | import { DefaultPalette } from '@fluentui/theme/lib/colors/DefaultPalette';
|
16 | import { fontFace } from '@uifabric/merge-styles';
|
17 | import { FontSizes } from '@fluentui/theme/lib/fonts/index';
|
18 | import { FontWeights } from '@fluentui/theme/lib/fonts/index';
|
19 | import { IAnimationStyles } from '@fluentui/theme/lib/types/IAnimationStyles';
|
20 | import { IAnimationVariables } from '@fluentui/theme/lib/types/IAnimationStyles';
|
21 | import { IconFontSizes } from '@fluentui/theme/lib/fonts/index';
|
22 | import { ICSPSettings } from '@uifabric/merge-styles';
|
23 | import { ICustomizerContext } from '@uifabric/utilities';
|
24 | import { IEffects } from '@fluentui/theme/lib/types/IEffects';
|
25 | import { IFontFace } from '@uifabric/merge-styles';
|
26 | import { IFontStyles } from '@fluentui/theme/lib/types/IFontStyles';
|
27 | import { IFontWeight } from '@uifabric/merge-styles';
|
28 | import { InjectionMode } from '@uifabric/merge-styles';
|
29 | import { IPalette } from '@fluentui/theme/lib/types/IPalette';
|
30 | import { IPartialTheme } from '@fluentui/theme/lib/types/ITheme';
|
31 | import { IProcessedStyleSet } from '@uifabric/merge-styles';
|
32 | import { IRawStyle } from '@uifabric/merge-styles';
|
33 | import { IScheme } from '@fluentui/theme/lib/types/ITheme';
|
34 | import { ISchemeNames } from '@fluentui/theme/lib/types/ITheme';
|
35 | import { ISemanticColors } from '@fluentui/theme/lib/types/ISemanticColors';
|
36 | import { ISemanticTextColors } from '@fluentui/theme/lib/types/ISemanticTextColors';
|
37 | import { ISpacing } from '@fluentui/theme/lib/types/ISpacing';
|
38 | import { IStyle } from '@uifabric/merge-styles';
|
39 | import { IStyleSet } from '@uifabric/merge-styles';
|
40 | import { IStyleSheetConfig } from '@uifabric/merge-styles';
|
41 | import { ITheme } from '@fluentui/theme/lib/types/ITheme';
|
42 | import { keyframes } from '@uifabric/merge-styles';
|
43 | import { mergeStyles } from '@uifabric/merge-styles';
|
44 | import { mergeStyleSets } from '@uifabric/merge-styles';
|
45 | import { registerDefaultFontFaces } from '@fluentui/theme/lib/fonts/DefaultFontStyles';
|
46 | import { Stylesheet } from '@uifabric/merge-styles';
|
47 |
|
48 | // @public (undocumented)
|
49 | export const AnimationClassNames: {
|
50 | [key in keyof IAnimationStyles]?: string;
|
51 | };
|
52 |
|
53 | export { AnimationStyles }
|
54 |
|
55 | export { AnimationVariables }
|
56 |
|
57 | // @public
|
58 | export 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)
|
65 | export const ColorClassNames: IColorClassNames;
|
66 |
|
67 | export { concatStyleSets }
|
68 |
|
69 | export { concatStyleSetsWithProps }
|
70 |
|
71 | export { createFontStyles }
|
72 |
|
73 | export { createTheme }
|
74 |
|
75 | export { DefaultEffects }
|
76 |
|
77 | export { DefaultFontStyles }
|
78 |
|
79 | export { DefaultPalette }
|
80 |
|
81 | // @public @deprecated (undocumented)
|
82 | export const EdgeChromiumHighContrastSelector = "@media screen and (-ms-high-contrast: active), screen and (forced-colors: active)";
|
83 |
|
84 | // @public
|
85 | export function focusClear(): IRawStyle;
|
86 |
|
87 | // @public (undocumented)
|
88 | export const FontClassNames: {
|
89 | [key in keyof IFontStyles]?: string;
|
90 | };
|
91 |
|
92 | export { fontFace }
|
93 |
|
94 | export { FontSizes }
|
95 |
|
96 | export { FontWeights }
|
97 |
|
98 | // @public @deprecated
|
99 | export function getEdgeChromiumNoHighContrastAdjustSelector(): {
|
100 | [EdgeChromiumHighContrastSelector]: IRawStyle;
|
101 | };
|
102 |
|
103 | // @public
|
104 | export function getFadedOverflowStyle(theme: ITheme, color?: keyof ISemanticColors | keyof IPalette, direction?: 'horizontal' | 'vertical', width?: string | number, height?: string | number): IRawStyle;
|
105 |
|
106 | // @public
|
107 | export function getFocusOutlineStyle(theme: ITheme, inset?: number, width?: number, color?: string): IRawStyle;
|
108 |
|
109 | // @public
|
110 | export function getFocusStyle(theme: ITheme, options?: IGetFocusStylesOptions): IRawStyle;
|
111 |
|
112 | // @public @deprecated
|
113 | export function getFocusStyle(theme: ITheme, inset?: number, position?: 'relative' | 'absolute', highContrastStyle?: IRawStyle | undefined, borderColor?: string, outlineColor?: string, isFocusedOnly?: boolean): IRawStyle;
|
114 |
|
115 | // @public
|
116 | export function getGlobalClassNames<T>(classNames: GlobalClassNames<T>, theme: ITheme, disableGlobalClassNames?: boolean): GlobalClassNames<T>;
|
117 |
|
118 | // @public
|
119 | export function getHighContrastNoAdjustStyle(): IRawStyle;
|
120 |
|
121 | // @public
|
122 | export function getIcon(name?: string): IIconRecord | undefined;
|
123 |
|
124 | // @public
|
125 | export function getIconClassName(name: string): string;
|
126 |
|
127 | // @public
|
128 | export const getInputFocusStyle: (borderColor: string, borderRadius: string | number, borderType?: "border" | "borderBottom", borderPosition?: number) => IRawStyle;
|
129 |
|
130 | // @public
|
131 | export function getPlaceholderStyles(styles: IStyle): IStyle;
|
132 |
|
133 | // @public (undocumented)
|
134 | export function getScreenSelector(min: number | undefined, max: number | undefined): string;
|
135 |
|
136 | // @public
|
137 | export 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
|
142 | export function getThemedContext(context: ICustomizerContext, scheme?: ISchemeNames, theme?: ITheme): ICustomizerContext;
|
143 |
|
144 | // @public (undocumented)
|
145 | export type GlobalClassNames<IStyles> = Record<keyof IStyles, string>;
|
146 |
|
147 | // @public (undocumented)
|
148 | export const hiddenContentStyle: IRawStyle;
|
149 |
|
150 | // @public (undocumented)
|
151 | export const HighContrastSelector = "@media screen and (-ms-high-contrast: active), screen and (forced-colors: active)";
|
152 |
|
153 | // @public (undocumented)
|
154 | export const HighContrastSelectorBlack = "@media screen and (-ms-high-contrast: white-on-black), screen and (forced-colors: active) and (prefers-color-scheme: dark)";
|
155 |
|
156 | // @public (undocumented)
|
157 | export const HighContrastSelectorWhite = "@media screen and (-ms-high-contrast: black-on-white), screen and (forced-colors: active) and (prefers-color-scheme: light)";
|
158 |
|
159 | export { IAnimationStyles }
|
160 |
|
161 | export { IAnimationVariables }
|
162 |
|
163 | export { IconFontSizes }
|
164 |
|
165 | export { ICSPSettings }
|
166 |
|
167 | export { IEffects }
|
168 |
|
169 | export { IFontFace }
|
170 |
|
171 | export { IFontStyles }
|
172 |
|
173 | export { IFontWeight }
|
174 |
|
175 | // @public (undocumented)
|
176 | export 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)
|
187 | export interface IIconOptions {
|
188 | disableWarnings: boolean;
|
189 | // @deprecated (undocumented)
|
190 | warnOnMissingIcons?: boolean;
|
191 | }
|
192 |
|
193 | // @public (undocumented)
|
194 | export interface IIconRecord {
|
195 | // (undocumented)
|
196 | code: string | undefined;
|
197 | // (undocumented)
|
198 | subset: IIconSubsetRecord;
|
199 | }
|
200 |
|
201 | // @public (undocumented)
|
202 | export 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)
|
215 | export interface IIconSubsetRecord extends IIconSubset {
|
216 | // (undocumented)
|
217 | className?: string;
|
218 | // (undocumented)
|
219 | isRegistered?: boolean;
|
220 | }
|
221 |
|
222 | export { InjectionMode }
|
223 |
|
224 | export { IPalette }
|
225 |
|
226 | export { IPartialTheme }
|
227 |
|
228 | export { IProcessedStyleSet }
|
229 |
|
230 | export { IRawStyle }
|
231 |
|
232 | export { IScheme }
|
233 |
|
234 | export { ISchemeNames }
|
235 |
|
236 | export { ISemanticColors }
|
237 |
|
238 | export { ISemanticTextColors }
|
239 |
|
240 | export { ISpacing }
|
241 |
|
242 | export { IStyle }
|
243 |
|
244 | export { IStyleSet }
|
245 |
|
246 | export { IStyleSheetConfig }
|
247 |
|
248 | export { ITheme }
|
249 |
|
250 | export { keyframes }
|
251 |
|
252 | // @public
|
253 | export function loadTheme(theme: IPartialTheme, depComments?: boolean): ITheme;
|
254 |
|
255 | export { mergeStyles }
|
256 |
|
257 | export { mergeStyleSets }
|
258 |
|
259 | // @public (undocumented)
|
260 | export const normalize: IRawStyle;
|
261 |
|
262 | // @public (undocumented)
|
263 | export const noWrap: IRawStyle;
|
264 |
|
265 | // @public (undocumented)
|
266 | export const PulsingBeaconAnimationStyles: {
|
267 | continuousPulseAnimationDouble: typeof _continuousPulseAnimationDouble;
|
268 | continuousPulseAnimationSingle: typeof _continuousPulseAnimationSingle;
|
269 | createDefaultAnimation: typeof _createDefaultAnimation;
|
270 | };
|
271 |
|
272 | export { registerDefaultFontFaces }
|
273 |
|
274 | // @public
|
275 | export function registerIconAlias(iconName: string, mappedToName: string): void;
|
276 |
|
277 | // @public
|
278 | export function registerIcons(iconSubset: IIconSubset, options?: Partial<IIconOptions>): void;
|
279 |
|
280 | // @public
|
281 | export function registerOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
|
282 |
|
283 | // @public
|
284 | export function removeOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
|
285 |
|
286 | // @public (undocumented)
|
287 | export const ScreenWidthMaxLarge: number;
|
288 |
|
289 | // @public (undocumented)
|
290 | export const ScreenWidthMaxMedium: number;
|
291 |
|
292 | // @public (undocumented)
|
293 | export const ScreenWidthMaxSmall: number;
|
294 |
|
295 | // @public (undocumented)
|
296 | export const ScreenWidthMaxXLarge: number;
|
297 |
|
298 | // @public (undocumented)
|
299 | export const ScreenWidthMaxXXLarge: number;
|
300 |
|
301 | // @public (undocumented)
|
302 | export const ScreenWidthMinLarge = 640;
|
303 |
|
304 | // @public (undocumented)
|
305 | export const ScreenWidthMinMedium = 480;
|
306 |
|
307 | // @public (undocumented)
|
308 | export const ScreenWidthMinSmall = 320;
|
309 |
|
310 | // @public (undocumented)
|
311 | export const ScreenWidthMinUhfMobile = 768;
|
312 |
|
313 | // @public (undocumented)
|
314 | export const ScreenWidthMinXLarge = 1024;
|
315 |
|
316 | // @public (undocumented)
|
317 | export const ScreenWidthMinXXLarge = 1366;
|
318 |
|
319 | // @public (undocumented)
|
320 | export const ScreenWidthMinXXXLarge = 1920;
|
321 |
|
322 | // @public
|
323 | export function setIconOptions(options: Partial<IIconOptions>): void;
|
324 |
|
325 | export { Stylesheet }
|
326 |
|
327 | // @public (undocumented)
|
328 | export const ThemeSettingName = "theme";
|
329 |
|
330 | // @public
|
331 | export function unregisterIcons(iconNames: string[]): void;
|
332 |
|
333 | // @public (undocumented)
|
334 | export 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 | ```
|