UNPKG

27.7 kBTypeScriptView Raw
1import { AnimationStyles } from '@fluentui/theme/lib/motion/AnimationStyles';
2import { AnimationVariables } from '@fluentui/theme/lib/motion/AnimationStyles';
3import { concatStyleSets } from '@uifabric/merge-styles';
4import { concatStyleSetsWithProps } from '@uifabric/merge-styles';
5import { createFontStyles } from '@fluentui/theme/lib/fonts/index';
6import { createTheme } from '@fluentui/theme/lib/createTheme';
7import { DefaultEffects } from '@fluentui/theme/lib/effects/DefaultEffects';
8import { DefaultFontStyles } from '@fluentui/theme/lib/fonts/DefaultFontStyles';
9import { DefaultPalette } from '@fluentui/theme/lib/colors/DefaultPalette';
10import { fontFace } from '@uifabric/merge-styles';
11import { FontSizes } from '@fluentui/theme/lib/fonts/index';
12import { FontWeights } from '@fluentui/theme/lib/fonts/index';
13import { IAnimationStyles } from '@fluentui/theme/lib/types/IAnimationStyles';
14import { IAnimationVariables } from '@fluentui/theme/lib/types/IAnimationStyles';
15import { IconFontSizes } from '@fluentui/theme/lib/fonts/index';
16import { ICSPSettings } from '@uifabric/merge-styles';
17import { ICustomizerContext } from '@uifabric/utilities';
18import { IEffects } from '@fluentui/theme/lib/types/IEffects';
19import { IFontFace } from '@uifabric/merge-styles';
20import { IFontStyles } from '@fluentui/theme/lib/types/IFontStyles';
21import { IFontWeight } from '@uifabric/merge-styles';
22import { InjectionMode } from '@uifabric/merge-styles';
23import { IPalette } from '@fluentui/theme/lib/types/IPalette';
24import { IPartialTheme } from '@fluentui/theme/lib/types/ITheme';
25import { IProcessedStyleSet } from '@uifabric/merge-styles';
26import { IRawStyle } from '@uifabric/merge-styles';
27import { IScheme } from '@fluentui/theme/lib/types/ITheme';
28import { ISchemeNames } from '@fluentui/theme/lib/types/ITheme';
29import { ISemanticColors } from '@fluentui/theme/lib/types/ISemanticColors';
30import { ISemanticTextColors } from '@fluentui/theme/lib/types/ISemanticTextColors';
31import { ISpacing } from '@fluentui/theme/lib/types/ISpacing';
32import { IStyle } from '@uifabric/merge-styles';
33import { IStyleSet } from '@uifabric/merge-styles';
34import { IStyleSheetConfig } from '@uifabric/merge-styles';
35import { ITheme } from '@fluentui/theme/lib/types/ITheme';
36import { keyframes } from '@uifabric/merge-styles';
37import { mergeStyles } from '@uifabric/merge-styles';
38import { mergeStyleSets } from '@uifabric/merge-styles';
39import { registerDefaultFontFaces } from '@fluentui/theme/lib/fonts/DefaultFontStyles';
40import { Stylesheet } from '@uifabric/merge-styles';
41
42/**
43 * {@docCategory AnimationClassNames}
44 */
45export declare const AnimationClassNames: {
46 [key in keyof IAnimationStyles]?: string;
47};
48export { AnimationStyles }
49export { AnimationVariables }
50
51/**
52 * Builds a class names object from a given map.
53 *
54 * @param styles - Map of unprocessed styles.
55 * @returns Map of property name to class name.
56 */
57export declare function buildClassMap<T extends Object>(styles: T): {
58 [key in keyof T]?: string;
59};
60
61export declare const ColorClassNames: IColorClassNames;
62export { concatStyleSets }
63export { concatStyleSetsWithProps }
64
65declare function _continuousPulseAnimationDouble(beaconColorOne: string, beaconColorTwo: string, innerDimension: string, outerDimension: string, borderWidth: string): string;
66
67declare function _continuousPulseAnimationSingle(beaconColorOne: string, beaconColorTwo: string, innerDimension: string, outerDimension: string, borderWidth: string): string;
68
69declare function _createDefaultAnimation(animationName: string, delayLength?: string): IRawStyle;
70export { createFontStyles }
71export { createTheme }
72export { DefaultEffects }
73export { DefaultFontStyles }
74export { DefaultPalette }
75
76export declare const EdgeChromiumHighContrastSelector = "@media screen and (forced-colors: active)";
77
78/**
79 * Generates style to clear browser specific focus styles.
80 */
81export declare function focusClear(): IRawStyle;
82
83/**
84 * {@docCategory FontClassNames}
85 */
86export declare const FontClassNames: {
87 [key in keyof IFontStyles]?: string;
88};
89export { fontFace }
90export { FontSizes }
91export { FontWeights }
92
93/**
94 * The style which turns off high contrast adjustment in (only) Edge Chromium browser.
95 * @deprecated Use `getHighContrastNoAdjustStyle`
96 */
97export declare function getEdgeChromiumNoHighContrastAdjustSelector(): {
98 [EdgeChromiumHighContrastSelector]: IRawStyle;
99};
100
101/**
102 * - Generates a style used to fade out an overflowing content by defining a style for an :after pseudo element.
103 * - Apply it to the :after selector for all combination of states the parent of content might have (normal, hover,
104 * selected, focus).
105 * - Requires the target to have position set to relative and overflow set to hidden.
106 *
107 * @example
108 * ```tsx
109 * // Assuming the following DOM structure and the different background colors coming from
110 * // the parent holding the content.
111 * <div className={classNames.parent}>
112 * <span className={classNames.content}>Overflown Content</span>
113 * </div>
114 * ```
115 * ```ts
116 * // This is how the style set would look in Component.styles.ts
117 * const { bodyBackground } = theme.semanticColors;
118 * const { neutralLighter } = theme.palette;
119 *
120 * // The second argument of getFadedOverflowStyle function is a string representing a key of
121 * // ISemanticColors or IPalette.
122 *
123 * const styles = {
124 * parent: [
125 * backgroundColor: bodyBackground,
126 * selectors: {
127 * '&:hover: {
128 * backgroundColor: neutralLighter
129 * },
130 * '$content:after': {
131 * ...getFadedOverflowStyle(theme, 'bodyBackground')
132 * },
133 * '&:hover $content:after': {
134 * ...getFadedOverflowStyle(theme, 'neutralLighter')
135 * }
136 * }
137 * ],
138 * content: [
139 * width: '100%',
140 * display: 'inline-block',
141 * position: 'relative',
142 * overflow: 'hidden'
143 * ]
144 * }
145 * ```
146 * @param theme - The theme object to use.
147 * @param color - The background color to fade out to. Accepts only keys of ISemanticColors or IPalette.
148 * Defaults to 'bodyBackground'.
149 * @param direction - The direction of the overflow. Defaults to horizontal.
150 * @param width - The width of the fading overflow. Vertical direction defaults it to 100% vs 20px when horizontal.
151 * @param height - The Height of the fading overflow. Vertical direction defaults it to 50% vs 100% when horizontal.
152 * @returns The style object.
153 */
154export declare function getFadedOverflowStyle(theme: ITheme, color?: keyof ISemanticColors | keyof IPalette, direction?: 'horizontal' | 'vertical', width?: string | number, height?: string | number): IRawStyle;
155
156/**
157 * Generates a style which can be used to set a border on focus.
158 *
159 * @param theme - The theme object to use.
160 * @param inset - The number of pixels to inset the border (default 0)
161 * @param width - The border width in pixels (default 1)
162 * @param color - Color of the outline (default `theme.palette.neutralSecondary`)
163 * @returns The style object.
164 */
165export declare function getFocusOutlineStyle(theme: ITheme, inset?: number, width?: number, color?: string): IRawStyle;
166
167/**
168 * Generates a focus style which can be used to define an :after focus border.
169 *
170 * @param theme - The theme object to use.
171 * @param options - Options to customize the focus border.
172 * @returns The style object.
173 */
174export declare function getFocusStyle(theme: ITheme, options?: IGetFocusStylesOptions): IRawStyle;
175
176/**
177 * Generates a focus style which can be used to define an :after focus border.
178 *
179 * @param theme - The theme object to use.
180 * @param inset - The number of pixels to inset the border.
181 * @param position - The positioning applied to the container. Must
182 * be 'relative' or 'absolute' so that the focus border can live around it.
183 * @param highContrastStyle - Style for high contrast mode.
184 * @param borderColor - Color of the border.
185 * @param outlineColor - Color of the outline.
186 * @param isFocusedOnly - If the styles should apply on focus or not.
187 * @returns The style object.
188 * @deprecated Use the object parameter version instead.
189 */
190export declare function getFocusStyle(theme: ITheme, inset?: number, position?: 'relative' | 'absolute', highContrastStyle?: IRawStyle | undefined, borderColor?: string, outlineColor?: string, isFocusedOnly?: boolean): IRawStyle;
191
192/**
193 * Checks for the `disableGlobalClassNames` property on the `theme` to determine if it should return `classNames`
194 * Note that calls to this function are memoized.
195 *
196 * @param classNames - The collection of global class names that apply when the flag is false. Make sure to pass in
197 * the same instance on each call to benefit from memoization.
198 * @param theme - The theme to check the flag on
199 * @param disableGlobalClassNames - Optional. Explicitly opt in/out of disabling global classnames. Defaults to false.
200 */
201export declare function getGlobalClassNames<T>(classNames: GlobalClassNames<T>, theme: ITheme, disableGlobalClassNames?: boolean): GlobalClassNames<T>;
202
203/**
204 * The style which turns off high contrast adjustment in browsers.
205 */
206export declare function getHighContrastNoAdjustStyle(): IRawStyle;
207
208/**
209 * Gets an icon definition. If an icon is requested but the subset has yet to be registered,
210 * it will get registered immediately.
211 *
212 * @public
213 * @param name - Name of icon.
214 */
215export declare function getIcon(name?: string): IIconRecord | undefined;
216
217/**
218 * Gets an icon classname. You should be able to add this classname to an I tag with no
219 * additional classnames, and render the icon.
220 *
221 * @public
222 */
223export declare function getIconClassName(name: string): string;
224
225/**
226 * Generates text input border styles on focus.
227 *
228 * @param borderColor - Color of the border.
229 * @param borderRadius - Radius of the border.
230 * @param borderType - Type of the border.
231 * @param borderPosition - Position of the border relative to the input element (default to -1
232 * as it's the most common border width of the input element)
233 * @returns The style object.
234 */
235export declare const getInputFocusStyle: (borderColor: string, borderRadius: string | number, borderType?: "border" | "borderBottom", borderPosition?: number) => IRawStyle;
236
237/**
238 * Generates placeholder style for each of the browsers supported by office-ui-fabric-react.
239 * @param styles - The style to use.
240 * @returns The placeholder style object for each browser depending on the placeholder directive it uses.
241 */
242export declare function getPlaceholderStyles(styles: IStyle): IStyle;
243
244export declare function getScreenSelector(min: number | undefined, max: number | undefined): string;
245
246/**
247 * Gets the theme object
248 * @param depComments - Whether to include deprecated tags as comments for deprecated slots.
249 */
250export declare function getTheme(depComments?: boolean): ITheme;
251
252/**
253 * @internal
254 * This function is still in experimental phase in support of Foundation experimental development.
255 * Its API signature and existence are subject to change.
256 *
257 * Modify context to activate the specified scheme or theme. For schemes, look in context (if available) and fall back
258 * to global Customizations. If both scheme and theme are specified, scheme will be looked up in theme. In this case,
259 * scheme must be present in theme arg, otherwise new context will default to theme arg (there is no fallback to
260 * settings to look up scheme.)
261 *
262 * @param context - Context in which to get schemed customizations.
263 * @param scheme - Scheme to get customizations for from theme arg (if supplied) OR from context and global settings.
264 * @param theme - Theme to merge into context.
265 * @returns modified schemed context if scheme is valid and not already applied, unmodified context otherwise.
266 */
267export declare function getThemedContext(context: ICustomizerContext, scheme?: ISchemeNames, theme?: ITheme): ICustomizerContext;
268
269export declare type GlobalClassNames<IStyles> = Record<keyof IStyles, string>;
270
271export declare const hiddenContentStyle: IRawStyle;
272
273export declare const HighContrastSelector = "@media screen and (-ms-high-contrast: active), (forced-colors: active)";
274
275export declare const HighContrastSelectorBlack = "@media screen and (-ms-high-contrast: white-on-black), (forced-colors: white-on-black)";
276
277export declare const HighContrastSelectorWhite = "@media screen and (-ms-high-contrast: black-on-white), (forced-colors: black-on-white)";
278export { IAnimationStyles }
279export { IAnimationVariables }
280
281/**
282 * {@docCategory IColorClassNames}
283 */
284declare interface IColorClassNames {
285 themeDarker: string;
286 themeDarkerHover: string;
287 themeDarkerBackground: string;
288 themeDarkerBackgroundHover: string;
289 themeDarkerBorder: string;
290 themeDarkerBorderHover: string;
291 themeDark: string;
292 themeDarkHover: string;
293 themeDarkBackground: string;
294 themeDarkBackgroundHover: string;
295 themeDarkBorder: string;
296 themeDarkBorderHover: string;
297 themeDarkAlt: string;
298 themeDarkAltHover: string;
299 themeDarkAltBackground: string;
300 themeDarkAltBackgroundHover: string;
301 themeDarkAltBorder: string;
302 themeDarkAltBorderHover: string;
303 themePrimary: string;
304 themePrimaryHover: string;
305 themePrimaryBackground: string;
306 themePrimaryBackgroundHover: string;
307 themePrimaryBorder: string;
308 themePrimaryBorderHover: string;
309 themeSecondary: string;
310 themeSecondaryHover: string;
311 themeSecondaryBackground: string;
312 themeSecondaryBackgroundHover: string;
313 themeSecondaryBorder: string;
314 themeSecondaryBorderHover: string;
315 themeTertiary: string;
316 themeTertiaryHover: string;
317 themeTertiaryBackground: string;
318 themeTertiaryBackgroundHover: string;
319 themeTertiaryBorder: string;
320 themeTertiaryBorderHover: string;
321 themeLight: string;
322 themeLightHover: string;
323 themeLightBackground: string;
324 themeLightBackgroundHover: string;
325 themeLightBorder: string;
326 themeLightBorderHover: string;
327 themeLighter: string;
328 themeLighterHover: string;
329 themeLighterBackground: string;
330 themeLighterBackgroundHover: string;
331 themeLighterBorder: string;
332 themeLighterBorderHover: string;
333 themeLighterAlt: string;
334 themeLighterAltHover: string;
335 themeLighterAltBackground: string;
336 themeLighterAltBackgroundHover: string;
337 themeLighterAltBorder: string;
338 themeLighterAltBorderHover: string;
339 black: string;
340 blackHover: string;
341 blackBackground: string;
342 blackBackgroundHover: string;
343 blackBorder: string;
344 blackBorderHover: string;
345 blackTranslucent40: string;
346 blackTranslucent40Hover: string;
347 blackTranslucent40Background: string;
348 blackTranslucent40BackgroundHover: string;
349 blackTranslucent40Border: string;
350 blackTranslucent40BorderHover: string;
351 neutralDark: string;
352 neutralDarkHover: string;
353 neutralDarkBackground: string;
354 neutralDarkBackgroundHover: string;
355 neutralDarkBorder: string;
356 neutralDarkBorderHover: string;
357 neutralPrimary: string;
358 neutralPrimaryHover: string;
359 neutralPrimaryBackground: string;
360 neutralPrimaryBackgroundHover: string;
361 neutralPrimaryBorder: string;
362 neutralPrimaryBorderHover: string;
363 neutralPrimaryAlt: string;
364 neutralPrimaryAltHover: string;
365 neutralPrimaryAltBackground: string;
366 neutralPrimaryAltBackgroundHover: string;
367 neutralPrimaryAltBorder: string;
368 neutralPrimaryAltBorderHover: string;
369 neutralSecondary: string;
370 neutralSecondaryHover: string;
371 neutralSecondaryBackground: string;
372 neutralSecondaryBackgroundHover: string;
373 neutralSecondaryBorder: string;
374 neutralSecondaryBorderHover: string;
375 neutralSecondaryAlt: string;
376 neutralSecondaryAltHover: string;
377 neutralSecondaryAltBackground: string;
378 neutralSecondaryAltBackgroundHover: string;
379 neutralSecondaryAltBorder: string;
380 neutralSecondaryAltBorderHover: string;
381 neutralTertiary: string;
382 neutralTertiaryHover: string;
383 neutralTertiaryBackground: string;
384 neutralTertiaryBackgroundHover: string;
385 neutralTertiaryBorder: string;
386 neutralTertiaryBorderHover: string;
387 neutralTertiaryAlt: string;
388 neutralTertiaryAltHover: string;
389 neutralTertiaryAltBackground: string;
390 neutralTertiaryAltBackgroundHover: string;
391 neutralTertiaryAltBorder: string;
392 neutralTertiaryAltBorderHover: string;
393 neutralQuaternary: string;
394 neutralQuaternaryHover: string;
395 neutralQuaternaryBackground: string;
396 neutralQuaternaryBackgroundHover: string;
397 neutralQuaternaryBorder: string;
398 neutralQuaternaryBorderHover: string;
399 neutralQuaternaryAlt: string;
400 neutralQuaternaryAltHover: string;
401 neutralQuaternaryAltBackground: string;
402 neutralQuaternaryAltBackgroundHover: string;
403 neutralQuaternaryAltBorder: string;
404 neutralQuaternaryAltBorderHover: string;
405 neutralLight: string;
406 neutralLightHover: string;
407 neutralLightBackground: string;
408 neutralLightBackgroundHover: string;
409 neutralLightBorder: string;
410 neutralLightBorderHover: string;
411 neutralLighter: string;
412 neutralLighterHover: string;
413 neutralLighterBackground: string;
414 neutralLighterBackgroundHover: string;
415 neutralLighterBorder: string;
416 neutralLighterBorderHover: string;
417 neutralLighterAlt: string;
418 neutralLighterAltHover: string;
419 neutralLighterAltBackground: string;
420 neutralLighterAltBackgroundHover: string;
421 neutralLighterAltBorder: string;
422 neutralLighterAltBorderHover: string;
423 white: string;
424 whiteHover: string;
425 whiteBackground: string;
426 whiteBackgroundHover: string;
427 whiteBorder: string;
428 whiteBorderHover: string;
429 whiteTranslucent40: string;
430 whiteTranslucent40Hover: string;
431 whiteTranslucent40Background: string;
432 whiteTranslucent40BackgroundHover: string;
433 whiteTranslucent40Border: string;
434 whiteTranslucent40BorderHover: string;
435 yellow: string;
436 yellowHover: string;
437 yellowBackground: string;
438 yellowBackgroundHover: string;
439 yellowBorder: string;
440 yellowBorderHover: string;
441 yellowLight: string;
442 yellowLightHover: string;
443 yellowLightBackground: string;
444 yellowLightBackgroundHover: string;
445 yellowLightBorder: string;
446 yellowLightBorderHover: string;
447 orange: string;
448 orangeHover: string;
449 orangeBackground: string;
450 orangeBackgroundHover: string;
451 orangeBorder: string;
452 orangeBorderHover: string;
453 orangeLight: string;
454 orangeLightHover: string;
455 orangeLightBackground: string;
456 orangeLightBackgroundHover: string;
457 orangeLightBorder: string;
458 orangeLightBorderHover: string;
459 orangeLighter: string;
460 orangeLighterHover: string;
461 orangeLighterBackground: string;
462 orangeLighterBackgroundHover: string;
463 orangeLighterBorder: string;
464 orangeLighterBorderHover: string;
465 redDark: string;
466 redDarkHover: string;
467 redDarkBackground: string;
468 redDarkBackgroundHover: string;
469 redDarkBorder: string;
470 redDarkBorderHover: string;
471 red: string;
472 redHover: string;
473 redBackground: string;
474 redBackgroundHover: string;
475 redBorder: string;
476 redBorderHover: string;
477 magentaDark: string;
478 magentaDarkHover: string;
479 magentaDarkBackground: string;
480 magentaDarkBackgroundHover: string;
481 magentaDarkBorder: string;
482 magentaDarkBorderHover: string;
483 magenta: string;
484 magentaHover: string;
485 magentaBackground: string;
486 magentaBackgroundHover: string;
487 magentaBorder: string;
488 magentaBorderHover: string;
489 magentaLight: string;
490 magentaLightHover: string;
491 magentaLightBackground: string;
492 magentaLightBackgroundHover: string;
493 magentaLightBorder: string;
494 magentaLightBorderHover: string;
495 purpleDark: string;
496 purpleDarkHover: string;
497 purpleDarkBackground: string;
498 purpleDarkBackgroundHover: string;
499 purpleDarkBorder: string;
500 purpleDarkBorderHover: string;
501 purple: string;
502 purpleHover: string;
503 purpleBackground: string;
504 purpleBackgroundHover: string;
505 purpleBorder: string;
506 purpleBorderHover: string;
507 purpleLight: string;
508 purpleLightHover: string;
509 purpleLightBackground: string;
510 purpleLightBackgroundHover: string;
511 purpleLightBorder: string;
512 purpleLightBorderHover: string;
513 blueDark: string;
514 blueDarkHover: string;
515 blueDarkBackground: string;
516 blueDarkBackgroundHover: string;
517 blueDarkBorder: string;
518 blueDarkBorderHover: string;
519 blueMid: string;
520 blueMidHover: string;
521 blueMidBackground: string;
522 blueMidBackgroundHover: string;
523 blueMidBorder: string;
524 blueMidBorderHover: string;
525 blue: string;
526 blueHover: string;
527 blueBackground: string;
528 blueBackgroundHover: string;
529 blueBorder: string;
530 blueBorderHover: string;
531 blueLight: string;
532 blueLightHover: string;
533 blueLightBackground: string;
534 blueLightBackgroundHover: string;
535 blueLightBorder: string;
536 blueLightBorderHover: string;
537 tealDark: string;
538 tealDarkHover: string;
539 tealDarkBackground: string;
540 tealDarkBackgroundHover: string;
541 tealDarkBorder: string;
542 tealDarkBorderHover: string;
543 teal: string;
544 tealHover: string;
545 tealBackground: string;
546 tealBackgroundHover: string;
547 tealBorder: string;
548 tealBorderHover: string;
549 tealLight: string;
550 tealLightHover: string;
551 tealLightBackground: string;
552 tealLightBackgroundHover: string;
553 tealLightBorder: string;
554 tealLightBorderHover: string;
555 greenDark: string;
556 greenDarkHover: string;
557 greenDarkBackground: string;
558 greenDarkBackgroundHover: string;
559 greenDarkBorder: string;
560 greenDarkBorderHover: string;
561 green: string;
562 greenHover: string;
563 greenBackground: string;
564 greenBackgroundHover: string;
565 greenBorder: string;
566 greenBorderHover: string;
567 greenLight: string;
568 greenLightHover: string;
569 greenLightBackground: string;
570 greenLightBackgroundHover: string;
571 greenLightBorder: string;
572 greenLightBorderHover: string;
573}
574export { IconFontSizes }
575export { ICSPSettings }
576export { IEffects }
577export { IFontFace }
578export { IFontStyles }
579export { IFontWeight }
580
581export declare interface IGetFocusStylesOptions {
582 /**
583 * The number of pixels to inset the border.
584 * @defaultvalue 0
585 */
586 inset?: number;
587 /**
588 * The width of the border in pixels.
589 * @defaultvalue 1
590 */
591 width?: number;
592 /**
593 * The positioning applied to the container.
594 * Must be 'relative' or 'absolute' so that the focus border can live around it.
595 * @defaultvalue 'relative'
596 */
597 position?: 'relative' | 'absolute';
598 /**
599 * Style for high contrast mode.
600 */
601 highContrastStyle?: IRawStyle;
602 /**
603 * Color of the border.
604 * @defaultvalue theme.palette.white
605 */
606 borderColor?: string;
607 /**
608 * Color of the outline.
609 * @defaultvalue theme.palette.neutralSecondary
610 */
611 outlineColor?: string;
612 /**
613 * If the styles should apply on `:focus` pseudo element.
614 * @defaultvalue true
615 */
616 isFocusedOnly?: boolean;
617}
618
619export declare interface IIconOptions {
620 /**
621 * By default, registering the same set of icons will generate a console warning per duplicate icon
622 * registered, because this scenario can create unexpected consequences.
623 *
624 * Some scenarios include:
625 *
626 * Icon set was previously registered using a different base url.
627 * Icon set was previously registered but a different version was provided.
628 * Icons in a previous registered set overlap with a new set.
629 *
630 * To simply ignore previously registered icons, you can specify to disable warnings. This means
631 * that if an icon which was previous registered is registered again, it will be silently ignored.
632 * However, consider whether the problems listed above will cause issues.
633 **/
634 disableWarnings: boolean;
635 /**
636 * @deprecated
637 * Use 'disableWarnings' instead.
638 */
639 warnOnMissingIcons?: boolean;
640}
641
642export declare interface IIconRecord {
643 code: string | undefined;
644 subset: IIconSubsetRecord;
645}
646
647export declare interface IIconSubset {
648 fontFace?: IFontFace;
649 icons: {
650 [key: string]: string | JSX.Element;
651 };
652 style?: IRawStyle;
653 /**
654 * Indicates to the icon renderer that it is safe to merge any props on the original `Icon` element
655 * onto the child content element registered for the icon which are valid for HTML images.
656 */
657 mergeImageProps?: boolean;
658}
659
660export declare interface IIconSubsetRecord extends IIconSubset {
661 isRegistered?: boolean;
662 className?: string;
663}
664export { InjectionMode }
665export { IPalette }
666export { IPartialTheme }
667export { IProcessedStyleSet }
668export { IRawStyle }
669export { IScheme }
670export { ISchemeNames }
671export { ISemanticColors }
672export { ISemanticTextColors }
673export { ISpacing }
674export { IStyle }
675export { IStyleSet }
676export { IStyleSheetConfig }
677export { ITheme }
678export { keyframes }
679
680/**
681 * Applies the theme, while filling in missing slots.
682 * @param theme - Partial theme object.
683 * @param depComments - Whether to include deprecated tags as comments for deprecated slots.
684 */
685export declare function loadTheme(theme: IPartialTheme, depComments?: boolean): ITheme;
686export { mergeStyles }
687export { mergeStyleSets }
688
689export declare const normalize: IRawStyle;
690
691export declare const noWrap: IRawStyle;
692
693export declare const PulsingBeaconAnimationStyles: {
694 continuousPulseAnimationDouble: typeof _continuousPulseAnimationDouble;
695 continuousPulseAnimationSingle: typeof _continuousPulseAnimationSingle;
696 createDefaultAnimation: typeof _createDefaultAnimation;
697};
698export { registerDefaultFontFaces }
699
700/**
701 * Remaps one icon name to another.
702 */
703export declare function registerIconAlias(iconName: string, mappedToName: string): void;
704
705/**
706 * Registers a given subset of icons.
707 *
708 * @param iconSubset - the icon subset definition.
709 */
710export declare function registerIcons(iconSubset: IIconSubset, options?: Partial<IIconOptions>): void;
711
712/**
713 * Registers a callback that gets called whenever the theme changes.
714 * This should only be used when the component cannot automatically get theme changes through its state.
715 * This will not register duplicate callbacks.
716 */
717export declare function registerOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
718
719/**
720 * See registerOnThemeChangeCallback().
721 * Removes previously registered callbacks.
722 */
723export declare function removeOnThemeChangeCallback(callback: (theme: ITheme) => void): void;
724
725export declare const ScreenWidthMaxLarge: number;
726
727export declare const ScreenWidthMaxMedium: number;
728
729export declare const ScreenWidthMaxSmall: number;
730
731export declare const ScreenWidthMaxXLarge: number;
732
733export declare const ScreenWidthMaxXXLarge: number;
734
735export declare const ScreenWidthMinLarge = 640;
736
737export declare const ScreenWidthMinMedium = 480;
738
739export declare const ScreenWidthMinSmall = 320;
740
741export declare const ScreenWidthMinUhfMobile = 768;
742
743export declare const ScreenWidthMinXLarge = 1024;
744
745export declare const ScreenWidthMinXXLarge = 1366;
746
747export declare const ScreenWidthMinXXXLarge = 1920;
748
749/**
750 * Sets the icon options.
751 *
752 * @public
753 */
754export declare function setIconOptions(options: Partial<IIconOptions>): void;
755export { Stylesheet }
756
757export declare const ThemeSettingName = "theme";
758
759/**
760 * Unregisters icons by name.
761 *
762 * @param iconNames - List of icons to unregister.
763 */
764export declare function unregisterIcons(iconNames: string[]): void;
765
766export declare namespace ZIndexes {
767 const Nav: number;
768 /**
769 * @deprecated ScrollablePane
770 */
771 const ScrollablePane: number;
772 const FocusStyle: number;
773 const Coachmark: number;
774 const Layer: number;
775 const KeytipLayer: number;
776}
777
778export { }