UNPKG

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