@fluentui/web-components 3.0.0-beta.48 → 3.0.0-beta.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -2
- package/dist/dts/avatar/avatar.d.ts +25 -17
- package/dist/dts/avatar/index.d.ts +1 -1
- package/dist/dts/index.d.ts +2 -2
- package/dist/dts/text-input/index.d.ts +1 -1
- package/dist/dts/text-input/text-input.d.ts +37 -29
- package/dist/esm/avatar/avatar.js +21 -13
- package/dist/esm/avatar/avatar.js.map +1 -1
- package/dist/esm/avatar/index.js +1 -1
- package/dist/esm/avatar/index.js.map +1 -1
- package/dist/esm/index.js +2 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/text-input/index.js +1 -1
- package/dist/esm/text-input/index.js.map +1 -1
- package/dist/esm/text-input/text-input.js +63 -55
- package/dist/esm/text-input/text-input.js.map +1 -1
- package/dist/web-components.d.ts +1169 -1151
- package/dist/web-components.js +67 -65
- package/dist/web-components.min.js +164 -164
- package/package.json +1 -1
package/dist/web-components.d.ts
CHANGED
|
@@ -445,47 +445,12 @@ export declare const AnchorTarget: {
|
|
|
445
445
|
export declare type AnchorTarget = ValuesOf<typeof AnchorTarget>;
|
|
446
446
|
|
|
447
447
|
/**
|
|
448
|
-
*
|
|
448
|
+
* An Avatar Custom HTML Element.
|
|
449
|
+
* Based on BaseAvatar and includes style and layout specific attributes
|
|
450
|
+
*
|
|
449
451
|
* @public
|
|
450
452
|
*/
|
|
451
|
-
export declare class Avatar extends
|
|
452
|
-
/**
|
|
453
|
-
* The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
|
|
454
|
-
*
|
|
455
|
-
* @internal
|
|
456
|
-
*/
|
|
457
|
-
elementInternals: ElementInternals;
|
|
458
|
-
/**
|
|
459
|
-
* The name of the person or entity represented by this Avatar. This should always be provided if it is available.
|
|
460
|
-
*
|
|
461
|
-
* @public
|
|
462
|
-
* @remarks
|
|
463
|
-
* HTML Attribute: name
|
|
464
|
-
*/
|
|
465
|
-
name?: string | undefined;
|
|
466
|
-
/**
|
|
467
|
-
* Provide custom initials rather than one generated via the name
|
|
468
|
-
*
|
|
469
|
-
* @public
|
|
470
|
-
* @remarks
|
|
471
|
-
* HTML Attribute: name
|
|
472
|
-
*/
|
|
473
|
-
initials?: string | undefined;
|
|
474
|
-
/**
|
|
475
|
-
* Size of the avatar in pixels.
|
|
476
|
-
*
|
|
477
|
-
* Size is restricted to a limited set of supported values recommended for most uses (see `AvatarSizeValue`) and
|
|
478
|
-
* based on design guidelines for the Avatar control.
|
|
479
|
-
*
|
|
480
|
-
* If a non-supported size is neeeded, set `size` to the next-smaller supported size, and set `width` and `height`
|
|
481
|
-
* to override the rendered size.
|
|
482
|
-
*
|
|
483
|
-
* @public
|
|
484
|
-
* @remarks
|
|
485
|
-
* HTML Attribute: size
|
|
486
|
-
*
|
|
487
|
-
*/
|
|
488
|
-
size?: AvatarSize | undefined;
|
|
453
|
+
export declare class Avatar extends BaseAvatar {
|
|
489
454
|
/**
|
|
490
455
|
* The avatar can have a circular or square shape.
|
|
491
456
|
*
|
|
@@ -494,17 +459,6 @@ export declare class Avatar extends FASTElement {
|
|
|
494
459
|
* HTML Attribute: shape
|
|
495
460
|
*/
|
|
496
461
|
shape?: AvatarShape | undefined;
|
|
497
|
-
/**
|
|
498
|
-
* Optional activity indicator
|
|
499
|
-
* * active: the avatar will be decorated according to activeAppearance
|
|
500
|
-
* * inactive: the avatar will be reduced in size and partially transparent
|
|
501
|
-
* * undefined: normal display
|
|
502
|
-
*
|
|
503
|
-
* @public
|
|
504
|
-
* @remarks
|
|
505
|
-
* HTML Attribute: active
|
|
506
|
-
*/
|
|
507
|
-
active?: AvatarActive | undefined;
|
|
508
462
|
/**
|
|
509
463
|
* The appearance when `active="active"`
|
|
510
464
|
*
|
|
@@ -513,51 +467,6 @@ export declare class Avatar extends FASTElement {
|
|
|
513
467
|
* HTML Attribute: appearance
|
|
514
468
|
*/
|
|
515
469
|
appearance?: AvatarAppearance | undefined;
|
|
516
|
-
/**
|
|
517
|
-
* The color when displaying either an icon or initials.
|
|
518
|
-
* * neutral (default): gray
|
|
519
|
-
* * brand: color from the brand palette
|
|
520
|
-
* * colorful: picks a color from a set of pre-defined colors, based on a hash of the name (or colorId if provided)
|
|
521
|
-
* * [AvatarNamedColor]: a specific color from the theme
|
|
522
|
-
*
|
|
523
|
-
* @public
|
|
524
|
-
* @remarks
|
|
525
|
-
* HTML Attribute: color
|
|
526
|
-
*/
|
|
527
|
-
color?: AvatarColor | undefined;
|
|
528
|
-
/**
|
|
529
|
-
* Specify a string to be used instead of the name, to determine which color to use when color="colorful".
|
|
530
|
-
* Use this when a name is not available, but there is another unique identifier that can be used instead.
|
|
531
|
-
*/
|
|
532
|
-
colorId?: AvatarNamedColor | undefined;
|
|
533
|
-
/**
|
|
534
|
-
* Holds the current color state
|
|
535
|
-
*/
|
|
536
|
-
private currentColor;
|
|
537
|
-
constructor();
|
|
538
|
-
connectedCallback(): void;
|
|
539
|
-
disconnectedCallback(): void;
|
|
540
|
-
/**
|
|
541
|
-
* Handles changes to observable properties
|
|
542
|
-
* @internal
|
|
543
|
-
* @param source - the source of the change
|
|
544
|
-
* @param propertyName - the property name being changed
|
|
545
|
-
*/
|
|
546
|
-
handleChange(source: any, propertyName: string): void;
|
|
547
|
-
/**
|
|
548
|
-
* Sets the data-color attribute used for the visual presentation
|
|
549
|
-
* @internal
|
|
550
|
-
*/
|
|
551
|
-
generateColor(): void;
|
|
552
|
-
/**
|
|
553
|
-
* Generates and sets the initials for the template
|
|
554
|
-
* @internal
|
|
555
|
-
*/
|
|
556
|
-
generateInitials(): string | void;
|
|
557
|
-
/**
|
|
558
|
-
* An array of the available Avatar named colors
|
|
559
|
-
*/
|
|
560
|
-
static colors: ("anchor" | "dark-red" | "cranberry" | "red" | "pumpkin" | "peach" | "marigold" | "gold" | "brass" | "brown" | "forest" | "seafoam" | "dark-green" | "light-teal" | "teal" | "steel" | "blue" | "royal-blue" | "cornflower" | "navy" | "lavender" | "purple" | "grape" | "lilac" | "pink" | "magenta" | "plum" | "beige" | "mink" | "platinum")[];
|
|
561
470
|
}
|
|
562
471
|
|
|
563
472
|
/**
|
|
@@ -1038,6 +947,106 @@ declare class BaseAnchor extends FASTElement {
|
|
|
1038
947
|
private createProxyElement;
|
|
1039
948
|
}
|
|
1040
949
|
|
|
950
|
+
/**
|
|
951
|
+
* The base class used for constructing a fluent-avatar custom element
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
export declare class BaseAvatar extends FASTElement {
|
|
955
|
+
/**
|
|
956
|
+
* The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
|
|
957
|
+
*
|
|
958
|
+
* @internal
|
|
959
|
+
*/
|
|
960
|
+
elementInternals: ElementInternals;
|
|
961
|
+
/**
|
|
962
|
+
* The name of the person or entity represented by this Avatar. This should always be provided if it is available.
|
|
963
|
+
*
|
|
964
|
+
* @public
|
|
965
|
+
* @remarks
|
|
966
|
+
* HTML Attribute: name
|
|
967
|
+
*/
|
|
968
|
+
name?: string | undefined;
|
|
969
|
+
/**
|
|
970
|
+
* Provide custom initials rather than one generated via the name
|
|
971
|
+
*
|
|
972
|
+
* @public
|
|
973
|
+
* @remarks
|
|
974
|
+
* HTML Attribute: name
|
|
975
|
+
*/
|
|
976
|
+
initials?: string | undefined;
|
|
977
|
+
/**
|
|
978
|
+
* Size of the avatar in pixels.
|
|
979
|
+
*
|
|
980
|
+
* Size is restricted to a limited set of supported values recommended for most uses (see `AvatarSizeValue`) and
|
|
981
|
+
* based on design guidelines for the Avatar control.
|
|
982
|
+
*
|
|
983
|
+
* If a non-supported size is neeeded, set `size` to the next-smaller supported size, and set `width` and `height`
|
|
984
|
+
* to override the rendered size.
|
|
985
|
+
*
|
|
986
|
+
* @public
|
|
987
|
+
* @remarks
|
|
988
|
+
* HTML Attribute: size
|
|
989
|
+
*
|
|
990
|
+
*/
|
|
991
|
+
size?: AvatarSize | undefined;
|
|
992
|
+
/**
|
|
993
|
+
* Optional activity indicator
|
|
994
|
+
* * active: the avatar will be decorated according to activeAppearance
|
|
995
|
+
* * inactive: the avatar will be reduced in size and partially transparent
|
|
996
|
+
* * undefined: normal display
|
|
997
|
+
*
|
|
998
|
+
* @public
|
|
999
|
+
* @remarks
|
|
1000
|
+
* HTML Attribute: active
|
|
1001
|
+
*/
|
|
1002
|
+
active?: AvatarActive | undefined;
|
|
1003
|
+
/**
|
|
1004
|
+
* The color when displaying either an icon or initials.
|
|
1005
|
+
* * neutral (default): gray
|
|
1006
|
+
* * brand: color from the brand palette
|
|
1007
|
+
* * colorful: picks a color from a set of pre-defined colors, based on a hash of the name (or colorId if provided)
|
|
1008
|
+
* * [AvatarNamedColor]: a specific color from the theme
|
|
1009
|
+
*
|
|
1010
|
+
* @public
|
|
1011
|
+
* @remarks
|
|
1012
|
+
* HTML Attribute: color
|
|
1013
|
+
*/
|
|
1014
|
+
color?: AvatarColor | undefined;
|
|
1015
|
+
/**
|
|
1016
|
+
* Specify a string to be used instead of the name, to determine which color to use when color="colorful".
|
|
1017
|
+
* Use this when a name is not available, but there is another unique identifier that can be used instead.
|
|
1018
|
+
*/
|
|
1019
|
+
colorId?: AvatarNamedColor | undefined;
|
|
1020
|
+
/**
|
|
1021
|
+
* Holds the current color state
|
|
1022
|
+
*/
|
|
1023
|
+
private currentColor;
|
|
1024
|
+
constructor();
|
|
1025
|
+
connectedCallback(): void;
|
|
1026
|
+
disconnectedCallback(): void;
|
|
1027
|
+
/**
|
|
1028
|
+
* Handles changes to observable properties
|
|
1029
|
+
* @internal
|
|
1030
|
+
* @param source - the source of the change
|
|
1031
|
+
* @param propertyName - the property name being changed
|
|
1032
|
+
*/
|
|
1033
|
+
handleChange(source: any, propertyName: string): void;
|
|
1034
|
+
/**
|
|
1035
|
+
* Sets the data-color attribute used for the visual presentation
|
|
1036
|
+
* @internal
|
|
1037
|
+
*/
|
|
1038
|
+
generateColor(): void;
|
|
1039
|
+
/**
|
|
1040
|
+
* Generates and sets the initials for the template
|
|
1041
|
+
* @internal
|
|
1042
|
+
*/
|
|
1043
|
+
generateInitials(): string | void;
|
|
1044
|
+
/**
|
|
1045
|
+
* An array of the available Avatar named colors
|
|
1046
|
+
*/
|
|
1047
|
+
static colors: ("anchor" | "dark-red" | "cranberry" | "red" | "pumpkin" | "peach" | "marigold" | "gold" | "brass" | "brown" | "forest" | "seafoam" | "dark-green" | "light-teal" | "teal" | "steel" | "blue" | "royal-blue" | "cornflower" | "navy" | "lavender" | "purple" | "grape" | "lilac" | "pink" | "magenta" | "plum" | "beige" | "mink" | "platinum")[];
|
|
1048
|
+
}
|
|
1049
|
+
|
|
1041
1050
|
/**
|
|
1042
1051
|
* A Button Custom HTML Element.
|
|
1043
1052
|
* Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | `<button>`} element.
|
|
@@ -1791,306 +1800,688 @@ declare class BaseTabs extends FASTElement {
|
|
|
1791
1800
|
}
|
|
1792
1801
|
|
|
1793
1802
|
/**
|
|
1794
|
-
*
|
|
1795
|
-
* @
|
|
1796
|
-
*/
|
|
1797
|
-
export declare const borderRadiusCircular = "var(--borderRadiusCircular)";
|
|
1798
|
-
|
|
1799
|
-
/**
|
|
1800
|
-
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusLarge | `borderRadiusLarge`} design token.
|
|
1801
|
-
* @public
|
|
1802
|
-
*/
|
|
1803
|
-
export declare const borderRadiusLarge = "var(--borderRadiusLarge)";
|
|
1804
|
-
|
|
1805
|
-
/**
|
|
1806
|
-
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusMedium | `borderRadiusMedium`} design token.
|
|
1807
|
-
* @public
|
|
1808
|
-
*/
|
|
1809
|
-
export declare const borderRadiusMedium = "var(--borderRadiusMedium)";
|
|
1810
|
-
|
|
1811
|
-
/**
|
|
1812
|
-
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusNone | `borderRadiusNone`} design token.
|
|
1813
|
-
* @public
|
|
1814
|
-
*/
|
|
1815
|
-
export declare const borderRadiusNone = "var(--borderRadiusNone)";
|
|
1816
|
-
|
|
1817
|
-
/**
|
|
1818
|
-
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusSmall | `borderRadiusSmall`} design token.
|
|
1819
|
-
* @public
|
|
1820
|
-
*/
|
|
1821
|
-
export declare const borderRadiusSmall = "var(--borderRadiusSmall)";
|
|
1822
|
-
|
|
1823
|
-
/**
|
|
1824
|
-
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusXLarge | `borderRadiusXLarge`} design token.
|
|
1825
|
-
* @public
|
|
1826
|
-
*/
|
|
1827
|
-
export declare const borderRadiusXLarge = "var(--borderRadiusXLarge)";
|
|
1828
|
-
|
|
1829
|
-
/**
|
|
1830
|
-
* A Button Custom HTML Element.
|
|
1831
|
-
* Based on BaseButton and includes style and layout specific attributes
|
|
1803
|
+
* A Text Input Custom HTML Element.
|
|
1804
|
+
* Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input | `<input>`} element.
|
|
1832
1805
|
*
|
|
1806
|
+
* @slot start - Content which can be provided before the input
|
|
1807
|
+
* @slot end - Content which can be provided after the input
|
|
1808
|
+
* @slot - The default slot for button content
|
|
1809
|
+
* @csspart label - The internal `<label>` element
|
|
1810
|
+
* @csspart root - the root container for the internal control
|
|
1811
|
+
* @csspart control - The internal `<input>` control
|
|
1833
1812
|
* @public
|
|
1834
1813
|
*/
|
|
1835
|
-
export declare class
|
|
1814
|
+
export declare class BaseTextInput extends FASTElement {
|
|
1836
1815
|
/**
|
|
1837
|
-
* Indicates the
|
|
1816
|
+
* Indicates the element's autocomplete state.
|
|
1817
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/autocomplete | `autocomplete`} attribute
|
|
1838
1818
|
*
|
|
1839
1819
|
* @public
|
|
1840
1820
|
* @remarks
|
|
1841
|
-
* HTML Attribute: `
|
|
1842
|
-
*/
|
|
1843
|
-
appearance?: ButtonAppearance;
|
|
1844
|
-
/**
|
|
1845
|
-
* Handles changes to appearance attribute custom states
|
|
1846
|
-
* @param prev - the previous state
|
|
1847
|
-
* @param next - the next state
|
|
1821
|
+
* HTML Attribute: `autocomplete`
|
|
1848
1822
|
*/
|
|
1849
|
-
|
|
1823
|
+
autocomplete?: string;
|
|
1850
1824
|
/**
|
|
1851
|
-
*
|
|
1852
|
-
*
|
|
1825
|
+
* Indicates that the element should get focus after the page finishes loading.
|
|
1826
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Element/input#autofocus | `autofocus`} attribute
|
|
1827
|
+
*
|
|
1853
1828
|
* @public
|
|
1854
1829
|
* @remarks
|
|
1855
|
-
* HTML Attribute: `
|
|
1830
|
+
* HTML Attribute: `autofocus`
|
|
1856
1831
|
*/
|
|
1857
|
-
|
|
1832
|
+
autofocus: boolean;
|
|
1858
1833
|
/**
|
|
1859
|
-
*
|
|
1860
|
-
*
|
|
1861
|
-
* @
|
|
1834
|
+
* The default slotted content. This is the content that appears in the text field label.
|
|
1835
|
+
*
|
|
1836
|
+
* @internal
|
|
1862
1837
|
*/
|
|
1863
|
-
|
|
1838
|
+
defaultSlottedNodes: Node[];
|
|
1864
1839
|
/**
|
|
1865
|
-
*
|
|
1840
|
+
* Updates the control label visibility based on the presence of default slotted content.
|
|
1866
1841
|
*
|
|
1867
|
-
* @
|
|
1868
|
-
* @remarks
|
|
1869
|
-
* HTML Attribute: `size`
|
|
1842
|
+
* @internal
|
|
1870
1843
|
*/
|
|
1871
|
-
|
|
1844
|
+
defaultSlottedNodesChanged(prev: Node[] | undefined, next: Node[] | undefined): void;
|
|
1872
1845
|
/**
|
|
1873
|
-
*
|
|
1874
|
-
* @
|
|
1875
|
-
*
|
|
1846
|
+
* Sets the directionality of the element to be submitted with form data.
|
|
1847
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/dirname | `dirname`} attribute
|
|
1848
|
+
*
|
|
1849
|
+
* @public
|
|
1850
|
+
* @remarks
|
|
1851
|
+
* HTML Attribute: `dirname`
|
|
1876
1852
|
*/
|
|
1877
|
-
|
|
1853
|
+
dirname?: string;
|
|
1878
1854
|
/**
|
|
1879
|
-
*
|
|
1855
|
+
* Sets the element's disabled state.
|
|
1856
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/disabled | `disabled`} attribute
|
|
1880
1857
|
*
|
|
1881
1858
|
* @public
|
|
1882
1859
|
* @remarks
|
|
1883
|
-
* HTML Attribute: `
|
|
1860
|
+
* HTML Attribute: `disabled`
|
|
1884
1861
|
*/
|
|
1885
|
-
|
|
1862
|
+
disabled?: boolean;
|
|
1886
1863
|
/**
|
|
1887
|
-
*
|
|
1888
|
-
* @
|
|
1889
|
-
*
|
|
1864
|
+
* The id of a form to associate the element to.
|
|
1865
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Element/input#form | `form`} attribute
|
|
1866
|
+
*
|
|
1867
|
+
* @public
|
|
1868
|
+
* @remarks
|
|
1869
|
+
* HTML Attribute: `form`
|
|
1890
1870
|
*/
|
|
1891
|
-
|
|
1892
|
-
}
|
|
1893
|
-
|
|
1894
|
-
/**
|
|
1895
|
-
* @internal
|
|
1896
|
-
* @privateRemarks
|
|
1897
|
-
* Mark internal because exporting class and interface of the same name confuses API documenter.
|
|
1898
|
-
* TODO: https://github.com/microsoft/fast/issues/3317
|
|
1899
|
-
*/
|
|
1900
|
-
export declare interface Button extends StartEnd {
|
|
1901
|
-
}
|
|
1902
|
-
|
|
1903
|
-
/**
|
|
1904
|
-
* ButtonAppearance constants
|
|
1905
|
-
* @public
|
|
1906
|
-
*/
|
|
1907
|
-
export declare const ButtonAppearance: {
|
|
1908
|
-
readonly primary: "primary";
|
|
1909
|
-
readonly outline: "outline";
|
|
1910
|
-
readonly subtle: "subtle";
|
|
1911
|
-
readonly transparent: "transparent";
|
|
1912
|
-
};
|
|
1913
|
-
|
|
1914
|
-
/**
|
|
1915
|
-
* A Button can be secondary, primary, outline, subtle, transparent
|
|
1916
|
-
* @public
|
|
1917
|
-
*/
|
|
1918
|
-
export declare type ButtonAppearance = ValuesOf<typeof ButtonAppearance>;
|
|
1919
|
-
|
|
1920
|
-
/**
|
|
1921
|
-
* The definition for the Fluent Button component.
|
|
1922
|
-
*
|
|
1923
|
-
* @public
|
|
1924
|
-
* @remarks
|
|
1925
|
-
* HTML Element: `<fluent-button>`
|
|
1926
|
-
*/
|
|
1927
|
-
export declare const ButtonDefinition: FASTElementDefinition<typeof Button>;
|
|
1928
|
-
|
|
1929
|
-
/**
|
|
1930
|
-
* Button `formtarget` attribute values.
|
|
1931
|
-
* @public
|
|
1932
|
-
*/
|
|
1933
|
-
export declare const ButtonFormTarget: {
|
|
1934
|
-
readonly blank: "_blank";
|
|
1935
|
-
readonly self: "_self";
|
|
1936
|
-
readonly parent: "_parent";
|
|
1937
|
-
readonly top: "_top";
|
|
1938
|
-
};
|
|
1939
|
-
|
|
1940
|
-
/**
|
|
1941
|
-
* Types for the `formtarget` attribute values.
|
|
1942
|
-
* @public
|
|
1943
|
-
*/
|
|
1944
|
-
export declare type ButtonFormTarget = ValuesOf<typeof ButtonFormTarget>;
|
|
1945
|
-
|
|
1946
|
-
/**
|
|
1947
|
-
* Button configuration options.
|
|
1948
|
-
* @public
|
|
1949
|
-
*/
|
|
1950
|
-
declare type ButtonOptions = StartEndOptions<Button>;
|
|
1951
|
-
export { ButtonOptions }
|
|
1952
|
-
export { ButtonOptions as MenuButtonOptions }
|
|
1953
|
-
export { ButtonOptions as ToggleButtonOptions }
|
|
1954
|
-
|
|
1955
|
-
/**
|
|
1956
|
-
* A Button can be square, circular or rounded.
|
|
1957
|
-
* @public
|
|
1958
|
-
*/
|
|
1959
|
-
export declare const ButtonShape: {
|
|
1960
|
-
readonly circular: "circular";
|
|
1961
|
-
readonly rounded: "rounded";
|
|
1962
|
-
readonly square: "square";
|
|
1963
|
-
};
|
|
1964
|
-
|
|
1965
|
-
/**
|
|
1966
|
-
* A Button can be square, circular or rounded
|
|
1967
|
-
* @public
|
|
1968
|
-
*/
|
|
1969
|
-
export declare type ButtonShape = ValuesOf<typeof ButtonShape>;
|
|
1970
|
-
|
|
1971
|
-
/**
|
|
1972
|
-
* A Button can be a size of small, medium or large.
|
|
1973
|
-
* @public
|
|
1974
|
-
*/
|
|
1975
|
-
export declare const ButtonSize: {
|
|
1976
|
-
readonly small: "small";
|
|
1977
|
-
readonly medium: "medium";
|
|
1978
|
-
readonly large: "large";
|
|
1979
|
-
};
|
|
1980
|
-
|
|
1981
|
-
/**
|
|
1982
|
-
* A Button can be on of several preset sizes.
|
|
1983
|
-
* @public
|
|
1984
|
-
*/
|
|
1985
|
-
export declare type ButtonSize = ValuesOf<typeof ButtonSize>;
|
|
1986
|
-
|
|
1987
|
-
/**
|
|
1988
|
-
* The template for the Button component.
|
|
1989
|
-
*
|
|
1990
|
-
* @public
|
|
1991
|
-
*/
|
|
1992
|
-
export declare const ButtonTemplate: ElementViewTemplate<Button>;
|
|
1993
|
-
|
|
1994
|
-
/**
|
|
1995
|
-
* Button type values.
|
|
1996
|
-
*
|
|
1997
|
-
* @public
|
|
1998
|
-
*/
|
|
1999
|
-
export declare const ButtonType: {
|
|
2000
|
-
readonly submit: "submit";
|
|
2001
|
-
readonly reset: "reset";
|
|
2002
|
-
readonly button: "button";
|
|
2003
|
-
};
|
|
2004
|
-
|
|
2005
|
-
/**
|
|
2006
|
-
* Type for button type values.
|
|
2007
|
-
*
|
|
2008
|
-
* @public
|
|
2009
|
-
*/
|
|
2010
|
-
export declare type ButtonType = ValuesOf<typeof ButtonType>;
|
|
2011
|
-
|
|
2012
|
-
/**
|
|
2013
|
-
* A Checkbox Custom HTML Element.
|
|
2014
|
-
* Implements the {@link https://w3c.github.io/aria/#checkbox | ARIA checkbox }.
|
|
2015
|
-
*
|
|
2016
|
-
* @slot checked-indicator - The checked indicator
|
|
2017
|
-
* @slot indeterminate-indicator - The indeterminate indicator
|
|
2018
|
-
* @fires change - Emits a custom change event when the checked state changes
|
|
2019
|
-
* @fires input - Emits a custom input event when the checked state changes
|
|
2020
|
-
*
|
|
2021
|
-
* @public
|
|
2022
|
-
*/
|
|
2023
|
-
export declare class Checkbox extends BaseCheckbox {
|
|
1871
|
+
formAttribute?: string;
|
|
2024
1872
|
/**
|
|
2025
|
-
*
|
|
1873
|
+
* The initial value of the input.
|
|
2026
1874
|
*
|
|
2027
1875
|
* @public
|
|
1876
|
+
* @remarks
|
|
1877
|
+
* HTML Attribute: `value`
|
|
2028
1878
|
*/
|
|
2029
|
-
|
|
1879
|
+
initialValue: string;
|
|
2030
1880
|
/**
|
|
2031
|
-
*
|
|
1881
|
+
* Sets the value of the element to the initial value.
|
|
2032
1882
|
*
|
|
2033
|
-
* @param prev - the indeterminate state
|
|
2034
|
-
* @param next - the current indeterminate state
|
|
2035
1883
|
* @internal
|
|
2036
1884
|
*/
|
|
2037
|
-
|
|
1885
|
+
initialValueChanged(): void;
|
|
2038
1886
|
/**
|
|
2039
|
-
*
|
|
1887
|
+
* Allows associating a `<datalist>` to the element by ID.
|
|
1888
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Element/input#list | `list`} attribute
|
|
2040
1889
|
*
|
|
2041
1890
|
* @public
|
|
2042
1891
|
* @remarks
|
|
2043
|
-
* HTML Attribute: `
|
|
1892
|
+
* HTML Attribute: `list`
|
|
2044
1893
|
*/
|
|
2045
|
-
|
|
1894
|
+
list: string;
|
|
2046
1895
|
/**
|
|
2047
|
-
*
|
|
1896
|
+
* The maximum number of characters a user can enter.
|
|
2048
1897
|
*
|
|
2049
|
-
* @
|
|
2050
|
-
* @
|
|
2051
|
-
*
|
|
1898
|
+
* @public
|
|
1899
|
+
* @remarks
|
|
1900
|
+
* HTML Attribute: `maxlength`
|
|
2052
1901
|
*/
|
|
2053
|
-
|
|
1902
|
+
maxlength: number;
|
|
2054
1903
|
/**
|
|
2055
|
-
*
|
|
1904
|
+
* The minimum number of characters a user can enter.
|
|
1905
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/minlength | `minlength`} attribute
|
|
2056
1906
|
*
|
|
2057
1907
|
* @public
|
|
2058
1908
|
* @remarks
|
|
2059
|
-
* HTML Attribute: `
|
|
1909
|
+
* HTML Attribute: `minlength`
|
|
2060
1910
|
*/
|
|
2061
|
-
|
|
1911
|
+
minlength: number;
|
|
2062
1912
|
/**
|
|
2063
|
-
*
|
|
1913
|
+
* Indicates that a comma-separated list of email addresses can be entered. This attribute is only valid when `type="email"`.
|
|
1914
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/multiple | `multiple`} attribute
|
|
2064
1915
|
*
|
|
2065
|
-
* @
|
|
2066
|
-
* @
|
|
2067
|
-
*
|
|
1916
|
+
* @public
|
|
1917
|
+
* @remarks
|
|
1918
|
+
* HTML Attribute: `multiple`
|
|
2068
1919
|
*/
|
|
2069
|
-
|
|
2070
|
-
constructor();
|
|
1920
|
+
multiple: boolean;
|
|
2071
1921
|
/**
|
|
2072
|
-
*
|
|
1922
|
+
* The name of the element. This element's value will be surfaced during form submission under the provided name.
|
|
2073
1923
|
*
|
|
2074
|
-
* @
|
|
2075
|
-
* @
|
|
1924
|
+
* @public
|
|
1925
|
+
* @remarks
|
|
1926
|
+
* HTML Attribute: `name`
|
|
2076
1927
|
*/
|
|
2077
|
-
|
|
1928
|
+
name: string;
|
|
2078
1929
|
/**
|
|
2079
|
-
*
|
|
1930
|
+
* A regular expression that the value must match to pass validation.
|
|
2080
1931
|
*
|
|
2081
|
-
* @param force - Forces the element to be checked or unchecked
|
|
2082
1932
|
* @public
|
|
1933
|
+
* @remarks
|
|
1934
|
+
* HTML Attribute: `pattern`
|
|
2083
1935
|
*/
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
1936
|
+
pattern: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* Sets the placeholder value of the element, generally used to provide a hint to the user.
|
|
1939
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/placeholder | `placeholder`} attribute
|
|
1940
|
+
*
|
|
1941
|
+
* @public
|
|
1942
|
+
* @remarks
|
|
1943
|
+
* HTML Attribute: `placeholder`
|
|
1944
|
+
* This attribute is not a valid substitute for a label.
|
|
1945
|
+
*/
|
|
1946
|
+
placeholder: string;
|
|
1947
|
+
/**
|
|
1948
|
+
* When true, the control will be immutable by user interaction.
|
|
1949
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/readonly | `readonly`} attribute
|
|
1950
|
+
*
|
|
1951
|
+
* @public
|
|
1952
|
+
* @remarks
|
|
1953
|
+
* HTML Attribute: `readonly`
|
|
1954
|
+
*/
|
|
1955
|
+
readOnly?: boolean;
|
|
1956
|
+
/**
|
|
1957
|
+
* Syncs the `ElementInternals.ariaReadOnly` property when the `readonly` property changes.
|
|
1958
|
+
*
|
|
1959
|
+
* @internal
|
|
1960
|
+
*/
|
|
1961
|
+
readOnlyChanged(): void;
|
|
1962
|
+
/**
|
|
1963
|
+
* The element's required attribute.
|
|
1964
|
+
*
|
|
1965
|
+
* @public
|
|
1966
|
+
* @remarks
|
|
1967
|
+
* HTML Attribute: `required`
|
|
1968
|
+
*/
|
|
1969
|
+
required: boolean;
|
|
1970
|
+
/**
|
|
1971
|
+
* Syncs the element's internal `aria-required` state with the `required` attribute.
|
|
1972
|
+
*
|
|
1973
|
+
* @param previous - the previous required state
|
|
1974
|
+
* @param next - the current required state
|
|
1975
|
+
*
|
|
1976
|
+
* @internal
|
|
1977
|
+
*/
|
|
1978
|
+
requiredChanged(previous: boolean, next: boolean): void;
|
|
1979
|
+
/**
|
|
1980
|
+
* Sets the width of the element to a specified number of characters.
|
|
1981
|
+
*
|
|
1982
|
+
* @public
|
|
1983
|
+
* @remarks
|
|
1984
|
+
* HTML Attribute: `size`
|
|
1985
|
+
*/
|
|
1986
|
+
size: number;
|
|
1987
|
+
/**
|
|
1988
|
+
* Controls whether or not to enable spell checking for the input field, or if the default spell checking configuration should be used.
|
|
1989
|
+
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Global_attributes/spellcheck | `spellcheck`} attribute
|
|
1990
|
+
*
|
|
1991
|
+
* @public
|
|
1992
|
+
* @remarks
|
|
1993
|
+
* HTML Attribute: `spellcheck`
|
|
1994
|
+
*/
|
|
1995
|
+
spellcheck: boolean;
|
|
1996
|
+
/**
|
|
1997
|
+
* Allows setting a type or mode of text.
|
|
1998
|
+
*
|
|
1999
|
+
* @public
|
|
2000
|
+
* @remarks
|
|
2001
|
+
* HTML Attribute: `type`
|
|
2002
|
+
*/
|
|
2003
|
+
type: TextInputType;
|
|
2004
|
+
/**
|
|
2005
|
+
* The current value of the input.
|
|
2006
|
+
*
|
|
2007
|
+
* @internal
|
|
2008
|
+
*/
|
|
2009
|
+
private _value;
|
|
2010
|
+
/**
|
|
2011
|
+
* A reference to the internal input element.
|
|
2012
|
+
*
|
|
2013
|
+
* @internal
|
|
2014
|
+
*/
|
|
2015
|
+
control: HTMLInputElement;
|
|
2016
|
+
/**
|
|
2017
|
+
* A reference to the internal label element.
|
|
2018
|
+
*
|
|
2019
|
+
* @internal
|
|
2020
|
+
*/
|
|
2021
|
+
controlLabel: HTMLLabelElement;
|
|
2022
|
+
/**
|
|
2023
|
+
* Indicates that the value has been changed by the user.
|
|
2024
|
+
*
|
|
2025
|
+
* @internal
|
|
2026
|
+
*/
|
|
2027
|
+
private dirtyValue;
|
|
2028
|
+
/**
|
|
2029
|
+
* The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
|
|
2030
|
+
*
|
|
2031
|
+
* @internal
|
|
2032
|
+
*/
|
|
2033
|
+
elementInternals: ElementInternals;
|
|
2034
|
+
/**
|
|
2035
|
+
* The form-associated flag.
|
|
2036
|
+
* @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements-face-example | Form-associated custom elements}
|
|
2037
|
+
*
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
static readonly formAssociated = true;
|
|
2041
|
+
/**
|
|
2042
|
+
* The element's validity state.
|
|
2043
|
+
*
|
|
2044
|
+
* @public
|
|
2045
|
+
* @remarks
|
|
2046
|
+
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/validity | `ElementInternals.validity`} property.
|
|
2047
|
+
*/
|
|
2048
|
+
get validity(): ValidityState;
|
|
2049
|
+
/**
|
|
2050
|
+
* The validation message.
|
|
2051
|
+
*
|
|
2052
|
+
* @public
|
|
2053
|
+
* @remarks
|
|
2054
|
+
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/validationMessage | `ElementInternals.validationMessage`} property.
|
|
2055
|
+
*/
|
|
2056
|
+
get validationMessage(): string;
|
|
2057
|
+
/**
|
|
2058
|
+
* The current value of the input.
|
|
2059
|
+
* @public
|
|
2060
|
+
*/
|
|
2061
|
+
get value(): string;
|
|
2062
|
+
set value(value: string);
|
|
2063
|
+
/**
|
|
2064
|
+
* Determines if the control can be submitted for constraint validation.
|
|
2065
|
+
*
|
|
2066
|
+
* @public
|
|
2067
|
+
* @remarks
|
|
2068
|
+
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/willValidate | `ElementInternals.willValidate`} property.
|
|
2069
|
+
*/
|
|
2070
|
+
get willValidate(): boolean;
|
|
2071
|
+
/**
|
|
2072
|
+
* The associated form element.
|
|
2073
|
+
*
|
|
2074
|
+
* @public
|
|
2075
|
+
* @remarks
|
|
2076
|
+
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/form | `ElementInternals.form`} property.
|
|
2077
|
+
*/
|
|
2078
|
+
get form(): HTMLFormElement | null;
|
|
2079
|
+
/**
|
|
2080
|
+
* Handles the internal control's `keypress` event.
|
|
2081
|
+
*
|
|
2082
|
+
* @internal
|
|
2083
|
+
*/
|
|
2084
|
+
beforeinputHandler(e: InputEvent): boolean | void;
|
|
2085
|
+
/**
|
|
2086
|
+
* Change event handler for inner control.
|
|
2087
|
+
*
|
|
2088
|
+
* @internal
|
|
2089
|
+
* @privateRemarks
|
|
2090
|
+
* "Change" events are not `composable` so they will not permeate the shadow DOM boundary. This function effectively
|
|
2091
|
+
* proxies the change event, emitting a `change` event whenever the internal control emits a `change` event.
|
|
2092
|
+
*/
|
|
2093
|
+
changeHandler(e: InputEvent): boolean | void;
|
|
2094
|
+
/**
|
|
2095
|
+
* Checks the validity of the element and returns the result.
|
|
2096
|
+
*
|
|
2097
|
+
* @public
|
|
2098
|
+
* @remarks
|
|
2099
|
+
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/checkValidity | `HTMLInputElement.checkValidity()`} method.
|
|
2100
|
+
*/
|
|
2101
|
+
checkValidity(): boolean;
|
|
2102
|
+
/**
|
|
2103
|
+
* Clicks the inner control when the component is clicked.
|
|
2104
|
+
*
|
|
2105
|
+
* @param e - the event object
|
|
2106
|
+
*/
|
|
2107
|
+
clickHandler(e: MouseEvent): boolean | void;
|
|
2108
|
+
connectedCallback(): void;
|
|
2109
|
+
/**
|
|
2110
|
+
* Focuses the inner control when the component is focused.
|
|
2111
|
+
*
|
|
2112
|
+
* @param e - the event object
|
|
2113
|
+
* @public
|
|
2114
|
+
*/
|
|
2115
|
+
focusinHandler(e: FocusEvent): boolean | void;
|
|
2116
|
+
/**
|
|
2117
|
+
* Resets the value to its initial value when the form is reset.
|
|
2118
|
+
*
|
|
2119
|
+
* @internal
|
|
2120
|
+
*/
|
|
2121
|
+
formResetCallback(): void;
|
|
2122
|
+
/**
|
|
2123
|
+
* Handles implicit form submission when the user presses the "Enter" key.
|
|
2124
|
+
*
|
|
2125
|
+
* @internal
|
|
2126
|
+
*/
|
|
2127
|
+
private implicitSubmit;
|
|
2128
|
+
/**
|
|
2129
|
+
* Handles the internal control's `input` event.
|
|
2130
|
+
*
|
|
2131
|
+
* @internal
|
|
2132
|
+
*/
|
|
2133
|
+
inputHandler(e: InputEvent): boolean | void;
|
|
2134
|
+
/**
|
|
2135
|
+
* Handles the internal control's `keydown` event.
|
|
2136
|
+
*
|
|
2137
|
+
* @param e - the event object
|
|
2138
|
+
* @internal
|
|
2139
|
+
*/
|
|
2140
|
+
keydownHandler(e: KeyboardEvent): boolean | void;
|
|
2141
|
+
/**
|
|
2142
|
+
* Selects all the text in the text field.
|
|
2143
|
+
*
|
|
2144
|
+
* @public
|
|
2145
|
+
* @privateRemarks
|
|
2146
|
+
* The `select` event does not permeate the shadow DOM boundary. This function effectively proxies the event,
|
|
2147
|
+
* emitting a `select` event whenever the internal control emits a `select` event
|
|
2148
|
+
*
|
|
2149
|
+
*/
|
|
2150
|
+
select(): void;
|
|
2151
|
+
/**
|
|
2152
|
+
* Sets the custom validity message.
|
|
2153
|
+
* @param message - The message to set
|
|
2154
|
+
*
|
|
2155
|
+
* @public
|
|
2156
|
+
*/
|
|
2157
|
+
setCustomValidity(message: string): void;
|
|
2158
|
+
/**
|
|
2159
|
+
* Reports the validity of the element.
|
|
2160
|
+
*
|
|
2161
|
+
* @public
|
|
2162
|
+
* @remarks
|
|
2163
|
+
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/reportValidity | `HTMLInputElement.reportValidity()`} method.
|
|
2164
|
+
*/
|
|
2165
|
+
reportValidity(): boolean;
|
|
2166
|
+
/**
|
|
2167
|
+
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/setFormValue | `ElementInternals.setFormValue()`} method.
|
|
2168
|
+
*
|
|
2169
|
+
* @internal
|
|
2170
|
+
*/
|
|
2171
|
+
setFormValue(value: File | string | FormData | null, state?: File | string | FormData | null): void;
|
|
2172
|
+
/**
|
|
2173
|
+
* Sets the validity of the control.
|
|
2174
|
+
*
|
|
2175
|
+
* @param flags - Validity flags. If not provided, the control's `validity` will be used.
|
|
2176
|
+
* @param message - Optional message to supply. If not provided, the control's `validationMessage` will be used. If the control does not have a `validationMessage`, the message will be empty.
|
|
2177
|
+
* @param anchor - Optional anchor to use for the validation message. If not provided, the control will be used.
|
|
2178
|
+
*
|
|
2179
|
+
* @internal
|
|
2180
|
+
*/
|
|
2181
|
+
setValidity(flags?: Partial<ValidityState>, message?: string, anchor?: HTMLElement): void;
|
|
2182
|
+
}
|
|
2183
|
+
|
|
2184
|
+
/**
|
|
2185
|
+
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusCircular | `borderRadiusCircular`} design token.
|
|
2186
|
+
* @public
|
|
2187
|
+
*/
|
|
2188
|
+
export declare const borderRadiusCircular = "var(--borderRadiusCircular)";
|
|
2189
|
+
|
|
2190
|
+
/**
|
|
2191
|
+
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusLarge | `borderRadiusLarge`} design token.
|
|
2192
|
+
* @public
|
|
2193
|
+
*/
|
|
2194
|
+
export declare const borderRadiusLarge = "var(--borderRadiusLarge)";
|
|
2195
|
+
|
|
2196
|
+
/**
|
|
2197
|
+
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusMedium | `borderRadiusMedium`} design token.
|
|
2198
|
+
* @public
|
|
2199
|
+
*/
|
|
2200
|
+
export declare const borderRadiusMedium = "var(--borderRadiusMedium)";
|
|
2201
|
+
|
|
2202
|
+
/**
|
|
2203
|
+
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusNone | `borderRadiusNone`} design token.
|
|
2204
|
+
* @public
|
|
2205
|
+
*/
|
|
2206
|
+
export declare const borderRadiusNone = "var(--borderRadiusNone)";
|
|
2207
|
+
|
|
2208
|
+
/**
|
|
2209
|
+
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusSmall | `borderRadiusSmall`} design token.
|
|
2210
|
+
* @public
|
|
2211
|
+
*/
|
|
2212
|
+
export declare const borderRadiusSmall = "var(--borderRadiusSmall)";
|
|
2213
|
+
|
|
2214
|
+
/**
|
|
2215
|
+
* CSS custom property value for the {@link @fluentui/tokens#borderRadiusXLarge | `borderRadiusXLarge`} design token.
|
|
2216
|
+
* @public
|
|
2217
|
+
*/
|
|
2218
|
+
export declare const borderRadiusXLarge = "var(--borderRadiusXLarge)";
|
|
2219
|
+
|
|
2220
|
+
/**
|
|
2221
|
+
* A Button Custom HTML Element.
|
|
2222
|
+
* Based on BaseButton and includes style and layout specific attributes
|
|
2223
|
+
*
|
|
2224
|
+
* @public
|
|
2225
|
+
*/
|
|
2226
|
+
export declare class Button extends BaseButton {
|
|
2227
|
+
/**
|
|
2228
|
+
* Indicates the styled appearance of the button.
|
|
2229
|
+
*
|
|
2230
|
+
* @public
|
|
2231
|
+
* @remarks
|
|
2232
|
+
* HTML Attribute: `appearance`
|
|
2233
|
+
*/
|
|
2234
|
+
appearance?: ButtonAppearance;
|
|
2235
|
+
/**
|
|
2236
|
+
* Handles changes to appearance attribute custom states
|
|
2237
|
+
* @param prev - the previous state
|
|
2238
|
+
* @param next - the next state
|
|
2239
|
+
*/
|
|
2240
|
+
appearanceChanged(prev: ButtonAppearance | undefined, next: ButtonAppearance | undefined): void;
|
|
2241
|
+
/**
|
|
2242
|
+
* The shape of the button.
|
|
2243
|
+
*
|
|
2244
|
+
* @public
|
|
2245
|
+
* @remarks
|
|
2246
|
+
* HTML Attribute: `shape`
|
|
2247
|
+
*/
|
|
2248
|
+
shape?: ButtonShape;
|
|
2249
|
+
/**
|
|
2250
|
+
* Handles changes to shape attribute custom states
|
|
2251
|
+
* @param prev - the previous state
|
|
2252
|
+
* @param next - the next state
|
|
2253
|
+
*/
|
|
2254
|
+
shapeChanged(prev: ButtonShape | undefined, next: ButtonShape | undefined): void;
|
|
2255
|
+
/**
|
|
2256
|
+
* The size of the button.
|
|
2257
|
+
*
|
|
2258
|
+
* @public
|
|
2259
|
+
* @remarks
|
|
2260
|
+
* HTML Attribute: `size`
|
|
2261
|
+
*/
|
|
2262
|
+
size?: ButtonSize;
|
|
2263
|
+
/**
|
|
2264
|
+
* Handles changes to size attribute custom states
|
|
2265
|
+
* @param prev - the previous state
|
|
2266
|
+
* @param next - the next state
|
|
2267
|
+
*/
|
|
2268
|
+
sizeChanged(prev: ButtonSize | undefined, next: ButtonSize | undefined): void;
|
|
2269
|
+
/**
|
|
2270
|
+
* Indicates that the button should only display as an icon with no text content.
|
|
2271
|
+
*
|
|
2272
|
+
* @public
|
|
2273
|
+
* @remarks
|
|
2274
|
+
* HTML Attribute: `icon-only`
|
|
2275
|
+
*/
|
|
2276
|
+
iconOnly: boolean;
|
|
2277
|
+
/**
|
|
2278
|
+
* Handles changes to icon only custom states
|
|
2279
|
+
* @param prev - the previous state
|
|
2280
|
+
* @param next - the next state
|
|
2281
|
+
*/
|
|
2282
|
+
iconOnlyChanged(prev: boolean, next: boolean): void;
|
|
2283
|
+
}
|
|
2284
|
+
|
|
2285
|
+
/**
|
|
2286
|
+
* @internal
|
|
2287
|
+
* @privateRemarks
|
|
2288
|
+
* Mark internal because exporting class and interface of the same name confuses API documenter.
|
|
2289
|
+
* TODO: https://github.com/microsoft/fast/issues/3317
|
|
2290
|
+
*/
|
|
2291
|
+
export declare interface Button extends StartEnd {
|
|
2292
|
+
}
|
|
2293
|
+
|
|
2294
|
+
/**
|
|
2295
|
+
* ButtonAppearance constants
|
|
2296
|
+
* @public
|
|
2297
|
+
*/
|
|
2298
|
+
export declare const ButtonAppearance: {
|
|
2299
|
+
readonly primary: "primary";
|
|
2300
|
+
readonly outline: "outline";
|
|
2301
|
+
readonly subtle: "subtle";
|
|
2302
|
+
readonly transparent: "transparent";
|
|
2303
|
+
};
|
|
2304
|
+
|
|
2305
|
+
/**
|
|
2306
|
+
* A Button can be secondary, primary, outline, subtle, transparent
|
|
2307
|
+
* @public
|
|
2308
|
+
*/
|
|
2309
|
+
export declare type ButtonAppearance = ValuesOf<typeof ButtonAppearance>;
|
|
2310
|
+
|
|
2311
|
+
/**
|
|
2312
|
+
* The definition for the Fluent Button component.
|
|
2313
|
+
*
|
|
2314
|
+
* @public
|
|
2315
|
+
* @remarks
|
|
2316
|
+
* HTML Element: `<fluent-button>`
|
|
2317
|
+
*/
|
|
2318
|
+
export declare const ButtonDefinition: FASTElementDefinition<typeof Button>;
|
|
2319
|
+
|
|
2320
|
+
/**
|
|
2321
|
+
* Button `formtarget` attribute values.
|
|
2322
|
+
* @public
|
|
2323
|
+
*/
|
|
2324
|
+
export declare const ButtonFormTarget: {
|
|
2325
|
+
readonly blank: "_blank";
|
|
2326
|
+
readonly self: "_self";
|
|
2327
|
+
readonly parent: "_parent";
|
|
2328
|
+
readonly top: "_top";
|
|
2329
|
+
};
|
|
2330
|
+
|
|
2331
|
+
/**
|
|
2332
|
+
* Types for the `formtarget` attribute values.
|
|
2333
|
+
* @public
|
|
2334
|
+
*/
|
|
2335
|
+
export declare type ButtonFormTarget = ValuesOf<typeof ButtonFormTarget>;
|
|
2336
|
+
|
|
2337
|
+
/**
|
|
2338
|
+
* Button configuration options.
|
|
2339
|
+
* @public
|
|
2340
|
+
*/
|
|
2341
|
+
declare type ButtonOptions = StartEndOptions<Button>;
|
|
2342
|
+
export { ButtonOptions }
|
|
2343
|
+
export { ButtonOptions as MenuButtonOptions }
|
|
2344
|
+
export { ButtonOptions as ToggleButtonOptions }
|
|
2345
|
+
|
|
2346
|
+
/**
|
|
2347
|
+
* A Button can be square, circular or rounded.
|
|
2348
|
+
* @public
|
|
2349
|
+
*/
|
|
2350
|
+
export declare const ButtonShape: {
|
|
2351
|
+
readonly circular: "circular";
|
|
2352
|
+
readonly rounded: "rounded";
|
|
2353
|
+
readonly square: "square";
|
|
2354
|
+
};
|
|
2355
|
+
|
|
2356
|
+
/**
|
|
2357
|
+
* A Button can be square, circular or rounded
|
|
2358
|
+
* @public
|
|
2359
|
+
*/
|
|
2360
|
+
export declare type ButtonShape = ValuesOf<typeof ButtonShape>;
|
|
2361
|
+
|
|
2362
|
+
/**
|
|
2363
|
+
* A Button can be a size of small, medium or large.
|
|
2364
|
+
* @public
|
|
2365
|
+
*/
|
|
2366
|
+
export declare const ButtonSize: {
|
|
2367
|
+
readonly small: "small";
|
|
2368
|
+
readonly medium: "medium";
|
|
2369
|
+
readonly large: "large";
|
|
2370
|
+
};
|
|
2371
|
+
|
|
2372
|
+
/**
|
|
2373
|
+
* A Button can be on of several preset sizes.
|
|
2374
|
+
* @public
|
|
2375
|
+
*/
|
|
2376
|
+
export declare type ButtonSize = ValuesOf<typeof ButtonSize>;
|
|
2377
|
+
|
|
2378
|
+
/**
|
|
2379
|
+
* The template for the Button component.
|
|
2380
|
+
*
|
|
2381
|
+
* @public
|
|
2382
|
+
*/
|
|
2383
|
+
export declare const ButtonTemplate: ElementViewTemplate<Button>;
|
|
2384
|
+
|
|
2385
|
+
/**
|
|
2386
|
+
* Button type values.
|
|
2387
|
+
*
|
|
2388
|
+
* @public
|
|
2389
|
+
*/
|
|
2390
|
+
export declare const ButtonType: {
|
|
2391
|
+
readonly submit: "submit";
|
|
2392
|
+
readonly reset: "reset";
|
|
2393
|
+
readonly button: "button";
|
|
2394
|
+
};
|
|
2395
|
+
|
|
2396
|
+
/**
|
|
2397
|
+
* Type for button type values.
|
|
2398
|
+
*
|
|
2399
|
+
* @public
|
|
2400
|
+
*/
|
|
2401
|
+
export declare type ButtonType = ValuesOf<typeof ButtonType>;
|
|
2402
|
+
|
|
2403
|
+
/**
|
|
2404
|
+
* A Checkbox Custom HTML Element.
|
|
2405
|
+
* Implements the {@link https://w3c.github.io/aria/#checkbox | ARIA checkbox }.
|
|
2406
|
+
*
|
|
2407
|
+
* @slot checked-indicator - The checked indicator
|
|
2408
|
+
* @slot indeterminate-indicator - The indeterminate indicator
|
|
2409
|
+
* @fires change - Emits a custom change event when the checked state changes
|
|
2410
|
+
* @fires input - Emits a custom input event when the checked state changes
|
|
2411
|
+
*
|
|
2412
|
+
* @public
|
|
2413
|
+
*/
|
|
2414
|
+
export declare class Checkbox extends BaseCheckbox {
|
|
2415
|
+
/**
|
|
2416
|
+
* Indicates that the element is in an indeterminate or mixed state.
|
|
2417
|
+
*
|
|
2418
|
+
* @public
|
|
2419
|
+
*/
|
|
2420
|
+
indeterminate?: boolean;
|
|
2421
|
+
/**
|
|
2422
|
+
* Updates the indeterminate state when the `indeterminate` property changes.
|
|
2423
|
+
*
|
|
2424
|
+
* @param prev - the indeterminate state
|
|
2425
|
+
* @param next - the current indeterminate state
|
|
2426
|
+
* @internal
|
|
2427
|
+
*/
|
|
2428
|
+
protected indeterminateChanged(prev: boolean | undefined, next: boolean | undefined): void;
|
|
2429
|
+
/**
|
|
2430
|
+
* Indicates the shape of the checkbox.
|
|
2431
|
+
*
|
|
2432
|
+
* @public
|
|
2433
|
+
* @remarks
|
|
2434
|
+
* HTML Attribute: `shape`
|
|
2435
|
+
*/
|
|
2436
|
+
shape?: CheckboxShape;
|
|
2437
|
+
/**
|
|
2438
|
+
* Applies shape states when the `shape` property changes.
|
|
2439
|
+
*
|
|
2440
|
+
* @param prev - the previous shape value
|
|
2441
|
+
* @param next - the next shape value
|
|
2442
|
+
* @internal
|
|
2443
|
+
*/
|
|
2444
|
+
protected shapeChanged(prev: CheckboxShape | undefined, next: CheckboxShape | undefined): void;
|
|
2445
|
+
/**
|
|
2446
|
+
* Indicates the size of the control.
|
|
2447
|
+
*
|
|
2448
|
+
* @public
|
|
2449
|
+
* @remarks
|
|
2450
|
+
* HTML Attribute: `size`
|
|
2451
|
+
*/
|
|
2452
|
+
size?: CheckboxSize;
|
|
2453
|
+
/**
|
|
2454
|
+
* Applies size states when the `size` property changes.
|
|
2455
|
+
*
|
|
2456
|
+
* @param prev - the previous state
|
|
2457
|
+
* @param next - the next state
|
|
2458
|
+
* @internal
|
|
2459
|
+
*/
|
|
2460
|
+
protected sizeChanged(prev: CheckboxSize | undefined, next: CheckboxSize | undefined): void;
|
|
2461
|
+
constructor();
|
|
2462
|
+
/**
|
|
2463
|
+
* Sets the ARIA checked state. If the `indeterminate` flag is true, the value will be 'mixed'.
|
|
2464
|
+
*
|
|
2465
|
+
* @internal
|
|
2466
|
+
* @override
|
|
2467
|
+
*/
|
|
2468
|
+
protected setAriaChecked(value?: boolean): void;
|
|
2469
|
+
/**
|
|
2470
|
+
* Toggles the checked state of the control.
|
|
2471
|
+
*
|
|
2472
|
+
* @param force - Forces the element to be checked or unchecked
|
|
2473
|
+
* @public
|
|
2474
|
+
*/
|
|
2475
|
+
toggleChecked(force?: boolean): void;
|
|
2476
|
+
}
|
|
2477
|
+
|
|
2478
|
+
/**
|
|
2479
|
+
* The Fluent Checkbox Element
|
|
2480
|
+
*
|
|
2481
|
+
* @public
|
|
2482
|
+
* @remarks
|
|
2483
|
+
* HTML Element: \<fluent-checkbox\>
|
|
2484
|
+
*/
|
|
2094
2485
|
export declare const CheckboxDefinition: FASTElementDefinition<typeof Checkbox>;
|
|
2095
2486
|
|
|
2096
2487
|
/**
|
|
@@ -7690,1016 +8081,643 @@ export declare const spacingHorizontalXXL = "var(--spacingHorizontalXXL)";
|
|
|
7690
8081
|
* CSS custom property value for the {@link @fluentui/tokens#spacingHorizontalXXS | `spacingHorizontalXXS`} design token.
|
|
7691
8082
|
* @public
|
|
7692
8083
|
*/
|
|
7693
|
-
export declare const spacingHorizontalXXS = "var(--spacingHorizontalXXS)";
|
|
7694
|
-
|
|
7695
|
-
/**
|
|
7696
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingHorizontalXXXL | `spacingHorizontalXXXL`} design token.
|
|
7697
|
-
* @public
|
|
7698
|
-
*/
|
|
7699
|
-
export declare const spacingHorizontalXXXL = "var(--spacingHorizontalXXXL)";
|
|
7700
|
-
|
|
7701
|
-
/**
|
|
7702
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalL | `spacingVerticalL`} design token.
|
|
7703
|
-
* @public
|
|
7704
|
-
*/
|
|
7705
|
-
export declare const spacingVerticalL = "var(--spacingVerticalL)";
|
|
7706
|
-
|
|
7707
|
-
/**
|
|
7708
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalM | `spacingVerticalM`} design token.
|
|
7709
|
-
* @public
|
|
7710
|
-
*/
|
|
7711
|
-
export declare const spacingVerticalM = "var(--spacingVerticalM)";
|
|
7712
|
-
|
|
7713
|
-
/**
|
|
7714
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalMNudge | `spacingVerticalMNudge`} design token.
|
|
7715
|
-
* @public
|
|
7716
|
-
*/
|
|
7717
|
-
export declare const spacingVerticalMNudge = "var(--spacingVerticalMNudge)";
|
|
7718
|
-
|
|
7719
|
-
/**
|
|
7720
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalNone | `spacingVerticalNone`} design token.
|
|
7721
|
-
* @public
|
|
7722
|
-
*/
|
|
7723
|
-
export declare const spacingVerticalNone = "var(--spacingVerticalNone)";
|
|
7724
|
-
|
|
7725
|
-
/**
|
|
7726
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalS | `spacingVerticalS`} design token.
|
|
7727
|
-
* @public
|
|
7728
|
-
*/
|
|
7729
|
-
export declare const spacingVerticalS = "var(--spacingVerticalS)";
|
|
7730
|
-
|
|
7731
|
-
/**
|
|
7732
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalSNudge | `spacingVerticalSNudge`} design token.
|
|
7733
|
-
* @public
|
|
7734
|
-
*/
|
|
7735
|
-
export declare const spacingVerticalSNudge = "var(--spacingVerticalSNudge)";
|
|
7736
|
-
|
|
7737
|
-
/**
|
|
7738
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXL | `spacingVerticalXL`} design token.
|
|
7739
|
-
* @public
|
|
7740
|
-
*/
|
|
7741
|
-
export declare const spacingVerticalXL = "var(--spacingVerticalXL)";
|
|
7742
|
-
|
|
7743
|
-
/**
|
|
7744
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXS | `spacingVerticalXS`} design token.
|
|
7745
|
-
* @public
|
|
7746
|
-
*/
|
|
7747
|
-
export declare const spacingVerticalXS = "var(--spacingVerticalXS)";
|
|
7748
|
-
|
|
7749
|
-
/**
|
|
7750
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXXL | `spacingVerticalXXL`} design token.
|
|
7751
|
-
* @public
|
|
7752
|
-
*/
|
|
7753
|
-
export declare const spacingVerticalXXL = "var(--spacingVerticalXXL)";
|
|
7754
|
-
|
|
7755
|
-
/**
|
|
7756
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXXS | `spacingVerticalXXS`} design token.
|
|
7757
|
-
* @public
|
|
7758
|
-
*/
|
|
7759
|
-
export declare const spacingVerticalXXS = "var(--spacingVerticalXXS)";
|
|
7760
|
-
|
|
7761
|
-
/**
|
|
7762
|
-
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXXXL | `spacingVerticalXXXL`} design token.
|
|
7763
|
-
* @public
|
|
7764
|
-
*/
|
|
7765
|
-
export declare const spacingVerticalXXXL = "var(--spacingVerticalXXXL)";
|
|
7766
|
-
|
|
7767
|
-
/**
|
|
7768
|
-
* A Spinner Custom HTML Element.
|
|
7769
|
-
* Based on BaseSpinner and includes style and layout specific attributes
|
|
7770
|
-
*
|
|
7771
|
-
* @public
|
|
7772
|
-
*/
|
|
7773
|
-
export declare class Spinner extends BaseSpinner {
|
|
7774
|
-
/**
|
|
7775
|
-
* The size of the spinner
|
|
7776
|
-
*
|
|
7777
|
-
* @public
|
|
7778
|
-
* @remarks
|
|
7779
|
-
* HTML Attribute: size
|
|
7780
|
-
*/
|
|
7781
|
-
size?: SpinnerSize;
|
|
7782
|
-
/**
|
|
7783
|
-
* Handles changes to size attribute custom states
|
|
7784
|
-
* @param prev - the previous state
|
|
7785
|
-
* @param next - the next state
|
|
7786
|
-
*/
|
|
7787
|
-
sizeChanged(prev: SpinnerSize | undefined, next: SpinnerSize | undefined): void;
|
|
7788
|
-
/**
|
|
7789
|
-
* The appearance of the spinner
|
|
7790
|
-
* @public
|
|
7791
|
-
* @remarks
|
|
7792
|
-
* HTML Attribute: appearance
|
|
7793
|
-
*/
|
|
7794
|
-
appearance?: SpinnerAppearance;
|
|
7795
|
-
/**
|
|
7796
|
-
* Handles changes to appearance attribute custom states
|
|
7797
|
-
* @param prev - the previous state
|
|
7798
|
-
* @param next - the next state
|
|
7799
|
-
*/
|
|
7800
|
-
appearanceChanged(prev: SpinnerAppearance | undefined, next: SpinnerAppearance | undefined): void;
|
|
7801
|
-
}
|
|
7802
|
-
|
|
7803
|
-
/**
|
|
7804
|
-
* SpinnerAppearance constants
|
|
7805
|
-
* @public
|
|
7806
|
-
*/
|
|
7807
|
-
export declare const SpinnerAppearance: {
|
|
7808
|
-
readonly primary: "primary";
|
|
7809
|
-
readonly inverted: "inverted";
|
|
7810
|
-
};
|
|
7811
|
-
|
|
7812
|
-
/**
|
|
7813
|
-
* A Spinner's appearance can be either primary or inverted
|
|
7814
|
-
* @public
|
|
7815
|
-
*/
|
|
7816
|
-
export declare type SpinnerAppearance = ValuesOf<typeof SpinnerAppearance>;
|
|
7817
|
-
|
|
7818
|
-
/**
|
|
7819
|
-
* @public
|
|
7820
|
-
* @remarks
|
|
7821
|
-
* HTML Element: \<fluent-spinner\>
|
|
7822
|
-
*/
|
|
7823
|
-
export declare const SpinnerDefinition: FASTElementDefinition<typeof Spinner>;
|
|
7824
|
-
|
|
7825
|
-
/**
|
|
7826
|
-
* SpinnerSize constants
|
|
7827
|
-
* @public
|
|
7828
|
-
*/
|
|
7829
|
-
export declare const SpinnerSize: {
|
|
7830
|
-
readonly tiny: "tiny";
|
|
7831
|
-
readonly extraSmall: "extra-small";
|
|
7832
|
-
readonly small: "small";
|
|
7833
|
-
readonly medium: "medium";
|
|
7834
|
-
readonly large: "large";
|
|
7835
|
-
readonly extraLarge: "extra-large";
|
|
7836
|
-
readonly huge: "huge";
|
|
7837
|
-
};
|
|
7838
|
-
|
|
7839
|
-
/**
|
|
7840
|
-
* A Spinner's size can be either small, tiny, extra-small, medium, large, extra-large, or huge
|
|
7841
|
-
* @public
|
|
7842
|
-
*/
|
|
7843
|
-
export declare type SpinnerSize = ValuesOf<typeof SpinnerSize>;
|
|
7844
|
-
|
|
7845
|
-
export declare const SpinnerStyles: ElementStyles;
|
|
7846
|
-
|
|
7847
|
-
export declare const SpinnerTemplate: ViewTemplate<Spinner, any>;
|
|
7848
|
-
|
|
7849
|
-
/**
|
|
7850
|
-
* A mixin class implementing start and end slots.
|
|
7851
|
-
* These are generally used to decorate text elements with icons or other visual indicators.
|
|
7852
|
-
* @public
|
|
7853
|
-
*/
|
|
7854
|
-
declare class StartEnd {
|
|
7855
|
-
start: HTMLSlotElement;
|
|
7856
|
-
end: HTMLSlotElement;
|
|
7857
|
-
}
|
|
7858
|
-
|
|
7859
|
-
/**
|
|
7860
|
-
* Start/End configuration options
|
|
7861
|
-
* @public
|
|
7862
|
-
*/
|
|
7863
|
-
declare type StartEndOptions<TSource = any, TParent = any> = StartOptions<TSource, TParent> & EndOptions<TSource, TParent>;
|
|
7864
|
-
|
|
7865
|
-
/**
|
|
7866
|
-
* Start configuration options
|
|
7867
|
-
* @public
|
|
7868
|
-
*/
|
|
7869
|
-
declare type StartOptions<TSource = any, TParent = any> = {
|
|
7870
|
-
start?: StaticallyComposableHTML<TSource, TParent>;
|
|
7871
|
-
};
|
|
7872
|
-
|
|
7873
|
-
/**
|
|
7874
|
-
* A value that can be statically composed into a
|
|
7875
|
-
* foundation template.
|
|
7876
|
-
* @remarks
|
|
7877
|
-
* When providing a string, take care to ensure that it is
|
|
7878
|
-
* safe and will not enable an XSS attack.
|
|
7879
|
-
* @public
|
|
7880
|
-
*/
|
|
7881
|
-
declare type StaticallyComposableHTML<TSource = any, TParent = any> = string | HTMLDirective | SyntheticViewTemplate<TSource, TParent> | undefined;
|
|
7882
|
-
|
|
7883
|
-
/**
|
|
7884
|
-
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThick | `strokeWidthThick`} design token.
|
|
7885
|
-
* @public
|
|
7886
|
-
*/
|
|
7887
|
-
export declare const strokeWidthThick = "var(--strokeWidthThick)";
|
|
7888
|
-
|
|
7889
|
-
/**
|
|
7890
|
-
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThicker | `strokeWidthThicker`} design token.
|
|
7891
|
-
* @public
|
|
7892
|
-
*/
|
|
7893
|
-
export declare const strokeWidthThicker = "var(--strokeWidthThicker)";
|
|
7894
|
-
|
|
7895
|
-
/**
|
|
7896
|
-
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThickest | `strokeWidthThickest`} design token.
|
|
7897
|
-
* @public
|
|
7898
|
-
*/
|
|
7899
|
-
export declare const strokeWidthThickest = "var(--strokeWidthThickest)";
|
|
7900
|
-
|
|
7901
|
-
/**
|
|
7902
|
-
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThin | `strokeWidthThin`} design token.
|
|
7903
|
-
* @public
|
|
7904
|
-
*/
|
|
7905
|
-
export declare const strokeWidthThin = "var(--strokeWidthThin)";
|
|
7906
|
-
|
|
7907
|
-
/**
|
|
7908
|
-
* The styles for the Button component.
|
|
7909
|
-
*
|
|
7910
|
-
* @public
|
|
7911
|
-
*/
|
|
7912
|
-
declare const styles: ElementStyles;
|
|
7913
|
-
export { styles as ButtonStyles }
|
|
7914
|
-
export { styles as MenuButtonStyles }
|
|
7915
|
-
|
|
7916
|
-
export declare class Switch extends BaseCheckbox {
|
|
7917
|
-
constructor();
|
|
7918
|
-
}
|
|
8084
|
+
export declare const spacingHorizontalXXS = "var(--spacingHorizontalXXS)";
|
|
7919
8085
|
|
|
7920
8086
|
/**
|
|
7921
|
-
*
|
|
7922
|
-
*
|
|
8087
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingHorizontalXXXL | `spacingHorizontalXXXL`} design token.
|
|
7923
8088
|
* @public
|
|
7924
|
-
* @remarks
|
|
7925
|
-
* HTML Element: \<fluent-switch\>
|
|
7926
8089
|
*/
|
|
7927
|
-
export declare const
|
|
8090
|
+
export declare const spacingHorizontalXXXL = "var(--spacingHorizontalXXXL)";
|
|
7928
8091
|
|
|
7929
8092
|
/**
|
|
7930
|
-
*
|
|
8093
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalL | `spacingVerticalL`} design token.
|
|
7931
8094
|
* @public
|
|
7932
8095
|
*/
|
|
7933
|
-
export declare const
|
|
7934
|
-
readonly above: "above";
|
|
7935
|
-
readonly after: "after";
|
|
7936
|
-
readonly before: "before";
|
|
7937
|
-
};
|
|
8096
|
+
export declare const spacingVerticalL = "var(--spacingVerticalL)";
|
|
7938
8097
|
|
|
7939
8098
|
/**
|
|
7940
|
-
*
|
|
8099
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalM | `spacingVerticalM`} design token.
|
|
7941
8100
|
* @public
|
|
7942
8101
|
*/
|
|
7943
|
-
export declare
|
|
7944
|
-
|
|
7945
|
-
export declare type SwitchOptions = {
|
|
7946
|
-
switch?: StaticallyComposableHTML<Switch>;
|
|
7947
|
-
};
|
|
7948
|
-
|
|
7949
|
-
export declare const SwitchStyles: ElementStyles;
|
|
7950
|
-
|
|
7951
|
-
export declare const SwitchTemplate: ElementViewTemplate<Switch>;
|
|
8102
|
+
export declare const spacingVerticalM = "var(--spacingVerticalM)";
|
|
7952
8103
|
|
|
7953
8104
|
/**
|
|
7954
|
-
*
|
|
8105
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalMNudge | `spacingVerticalMNudge`} design token.
|
|
8106
|
+
* @public
|
|
7955
8107
|
*/
|
|
7956
|
-
export declare
|
|
7957
|
-
/**
|
|
7958
|
-
* When true, the control will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute} for more information.
|
|
7959
|
-
* @public
|
|
7960
|
-
* @remarks
|
|
7961
|
-
* HTML Attribute: disabled
|
|
7962
|
-
*/
|
|
7963
|
-
disabled: boolean;
|
|
7964
|
-
private styles;
|
|
7965
|
-
connectedCallback(): void;
|
|
7966
|
-
}
|
|
7967
|
-
|
|
7968
|
-
export declare interface Tab extends StartEnd {
|
|
7969
|
-
}
|
|
7970
|
-
|
|
7971
|
-
export declare const TabDefinition: FASTElementDefinition<typeof Tab>;
|
|
8108
|
+
export declare const spacingVerticalMNudge = "var(--spacingVerticalMNudge)";
|
|
7972
8109
|
|
|
7973
8110
|
/**
|
|
7974
|
-
*
|
|
8111
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalNone | `spacingVerticalNone`} design token.
|
|
7975
8112
|
* @public
|
|
7976
8113
|
*/
|
|
7977
|
-
export declare
|
|
7978
|
-
|
|
7979
|
-
export declare class TabPanel extends FASTElement {
|
|
7980
|
-
}
|
|
7981
|
-
|
|
7982
|
-
export declare const TabPanelDefinition: FASTElementDefinition<typeof TabPanel>;
|
|
7983
|
-
|
|
7984
|
-
export declare const TabPanelStyles: ElementStyles;
|
|
7985
|
-
|
|
7986
|
-
export declare const TabPanelTemplate: ElementViewTemplate<TabPanel, any>;
|
|
7987
|
-
|
|
7988
|
-
export declare class Tabs extends BaseTabs {
|
|
7989
|
-
/**
|
|
7990
|
-
* activeTabData
|
|
7991
|
-
* The positional coordinates and size dimensions of the active tab. Used for calculating the offset and scale of the tab active indicator.
|
|
7992
|
-
*/
|
|
7993
|
-
private activeTabData;
|
|
7994
|
-
/**
|
|
7995
|
-
* previousActiveTabData
|
|
7996
|
-
* The positional coordinates and size dimensions of the active tab. Used for calculating the offset and scale of the tab active indicator.
|
|
7997
|
-
*/
|
|
7998
|
-
private previousActiveTabData;
|
|
7999
|
-
/**
|
|
8000
|
-
* activeTabOffset
|
|
8001
|
-
* Used to position the active indicator for animations of the active indicator on active tab changes.
|
|
8002
|
-
*/
|
|
8003
|
-
private activeTabOffset;
|
|
8004
|
-
/**
|
|
8005
|
-
* activeTabScale
|
|
8006
|
-
* Used to scale the tab active indicator up or down as animations of the active indicator occur.
|
|
8007
|
-
*/
|
|
8008
|
-
private activeTabScale;
|
|
8009
|
-
/**
|
|
8010
|
-
* styles
|
|
8011
|
-
* used in the class for storing the css variables required for animations
|
|
8012
|
-
*/
|
|
8013
|
-
private styles;
|
|
8014
|
-
/**
|
|
8015
|
-
* appearance
|
|
8016
|
-
* There are two modes of appearance: transparent and subtle.
|
|
8017
|
-
*/
|
|
8018
|
-
appearance?: TabsAppearance;
|
|
8019
|
-
/**
|
|
8020
|
-
* disabled
|
|
8021
|
-
* Used for disabling all click and keyboard events for the tabs, child tab elements and tab panel elements. UI styling of content and tabs will appear as "grayed out."
|
|
8022
|
-
*/
|
|
8023
|
-
disabled?: boolean;
|
|
8024
|
-
/**
|
|
8025
|
-
* size
|
|
8026
|
-
* defaults to medium.
|
|
8027
|
-
* Used to set the size of all the tab controls, which effects text size and margins. Three sizes: small, medium and large.
|
|
8028
|
-
*/
|
|
8029
|
-
size?: TabsSize;
|
|
8030
|
-
/**
|
|
8031
|
-
* calculateAnimationProperties
|
|
8032
|
-
*
|
|
8033
|
-
* Recalculates the active tab offset and scale.
|
|
8034
|
-
* These values will be applied to css variables that control the tab active indicator position animations
|
|
8035
|
-
*/
|
|
8036
|
-
private calculateAnimationProperties;
|
|
8037
|
-
/**
|
|
8038
|
-
* getSelectedTabPosition - gets the x or y coordinates of the tab
|
|
8039
|
-
*/
|
|
8040
|
-
private getTabPosition;
|
|
8041
|
-
/**
|
|
8042
|
-
* getSelectedTabScale - gets the scale of the tab
|
|
8043
|
-
*/
|
|
8044
|
-
private getTabScale;
|
|
8045
|
-
/**
|
|
8046
|
-
* Calculates and applies updated values to CSS variables.
|
|
8047
|
-
*
|
|
8048
|
-
* @param tab - the tab element to apply the updated values to
|
|
8049
|
-
* @internal
|
|
8050
|
-
*/
|
|
8051
|
-
private applyUpdatedCSSValues;
|
|
8052
|
-
/**
|
|
8053
|
-
* Runs through all the operations required for setting the tab active indicator to its starting location, ending
|
|
8054
|
-
* location, and applying the animated css class to the tab.
|
|
8055
|
-
*
|
|
8056
|
-
* @param tab - the tab element to apply the updated values to
|
|
8057
|
-
* @internal
|
|
8058
|
-
*/
|
|
8059
|
-
private animationLoop;
|
|
8060
|
-
/**
|
|
8061
|
-
* Sets the data from the active tab onto the class. used for making all the animation calculations for the active
|
|
8062
|
-
* tab indicator.
|
|
8063
|
-
*
|
|
8064
|
-
* @internal
|
|
8065
|
-
*/
|
|
8066
|
-
private setTabData;
|
|
8067
|
-
private setTabOffsetCSSVar;
|
|
8068
|
-
private setTabScaleCSSVar;
|
|
8069
|
-
activeidChanged(oldValue: string, newValue: string): void;
|
|
8070
|
-
tabsChanged(): void;
|
|
8071
|
-
}
|
|
8072
|
-
|
|
8073
|
-
export declare interface Tabs extends StartEnd {
|
|
8074
|
-
}
|
|
8075
|
-
|
|
8076
|
-
export declare const TabsAppearance: {
|
|
8077
|
-
readonly subtle: "subtle";
|
|
8078
|
-
readonly transparent: "transparent";
|
|
8079
|
-
};
|
|
8080
|
-
|
|
8081
|
-
export declare type TabsAppearance = ValuesOf<typeof TabsAppearance>;
|
|
8082
|
-
|
|
8083
|
-
export declare const TabsDefinition: FASTElementDefinition<typeof Tabs>;
|
|
8114
|
+
export declare const spacingVerticalNone = "var(--spacingVerticalNone)";
|
|
8084
8115
|
|
|
8085
8116
|
/**
|
|
8086
|
-
*
|
|
8117
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalS | `spacingVerticalS`} design token.
|
|
8087
8118
|
* @public
|
|
8088
8119
|
*/
|
|
8089
|
-
export declare
|
|
8120
|
+
export declare const spacingVerticalS = "var(--spacingVerticalS)";
|
|
8090
8121
|
|
|
8091
8122
|
/**
|
|
8092
|
-
*
|
|
8123
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalSNudge | `spacingVerticalSNudge`} design token.
|
|
8093
8124
|
* @public
|
|
8094
8125
|
*/
|
|
8095
|
-
export declare const
|
|
8096
|
-
readonly horizontal: "horizontal";
|
|
8097
|
-
readonly vertical: "vertical";
|
|
8098
|
-
};
|
|
8126
|
+
export declare const spacingVerticalSNudge = "var(--spacingVerticalSNudge)";
|
|
8099
8127
|
|
|
8100
8128
|
/**
|
|
8101
|
-
*
|
|
8129
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXL | `spacingVerticalXL`} design token.
|
|
8102
8130
|
* @public
|
|
8103
8131
|
*/
|
|
8104
|
-
export declare
|
|
8105
|
-
|
|
8106
|
-
export declare const TabsSize: {
|
|
8107
|
-
readonly small: "small";
|
|
8108
|
-
readonly medium: "medium";
|
|
8109
|
-
readonly large: "large";
|
|
8110
|
-
};
|
|
8111
|
-
|
|
8112
|
-
export declare type TabsSize = ValuesOf<typeof TabsSize>;
|
|
8113
|
-
|
|
8114
|
-
export declare const TabsStyles: ElementStyles;
|
|
8115
|
-
|
|
8116
|
-
export declare const TabsTemplate: ElementViewTemplate<Tabs, any>;
|
|
8117
|
-
|
|
8118
|
-
export declare const TabStyles: ElementStyles;
|
|
8132
|
+
export declare const spacingVerticalXL = "var(--spacingVerticalXL)";
|
|
8119
8133
|
|
|
8120
|
-
|
|
8134
|
+
/**
|
|
8135
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXS | `spacingVerticalXS`} design token.
|
|
8136
|
+
* @public
|
|
8137
|
+
*/
|
|
8138
|
+
export declare const spacingVerticalXS = "var(--spacingVerticalXS)";
|
|
8121
8139
|
|
|
8122
8140
|
/**
|
|
8123
|
-
*
|
|
8141
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXXL | `spacingVerticalXXL`} design token.
|
|
8124
8142
|
* @public
|
|
8125
8143
|
*/
|
|
8126
|
-
declare
|
|
8127
|
-
|
|
8128
|
-
|
|
8129
|
-
|
|
8130
|
-
|
|
8131
|
-
|
|
8132
|
-
|
|
8133
|
-
|
|
8134
|
-
|
|
8135
|
-
|
|
8136
|
-
|
|
8137
|
-
|
|
8138
|
-
|
|
8139
|
-
|
|
8140
|
-
|
|
8141
|
-
|
|
8142
|
-
|
|
8143
|
-
|
|
8144
|
-
|
|
8145
|
-
|
|
8146
|
-
|
|
8147
|
-
* @remarks
|
|
8148
|
-
* HTML Attribute: truncate
|
|
8149
|
-
*/
|
|
8150
|
-
truncate: boolean;
|
|
8151
|
-
/**
|
|
8152
|
-
* The text style is italic
|
|
8153
|
-
*
|
|
8154
|
-
* @public
|
|
8155
|
-
* @remarks
|
|
8156
|
-
* HTML Attribute: italic
|
|
8157
|
-
*/
|
|
8158
|
-
italic: boolean;
|
|
8159
|
-
/**
|
|
8160
|
-
* The text style is underline
|
|
8161
|
-
*
|
|
8162
|
-
* @public
|
|
8163
|
-
* @remarks
|
|
8164
|
-
* HTML Attribute: underline
|
|
8165
|
-
*/
|
|
8166
|
-
underline: boolean;
|
|
8167
|
-
/**
|
|
8168
|
-
* The text style is strikethrough
|
|
8169
|
-
*
|
|
8170
|
-
* @public
|
|
8171
|
-
* @remarks
|
|
8172
|
-
* HTML Attribute: strikethrough
|
|
8173
|
-
*/
|
|
8174
|
-
strikethrough: boolean;
|
|
8175
|
-
/**
|
|
8176
|
-
* An text can take up the width of its container.
|
|
8177
|
-
*
|
|
8178
|
-
* @public
|
|
8179
|
-
* @remarks
|
|
8180
|
-
* HTML Attribute: block
|
|
8181
|
-
*/
|
|
8182
|
-
block: boolean;
|
|
8144
|
+
export declare const spacingVerticalXXL = "var(--spacingVerticalXXL)";
|
|
8145
|
+
|
|
8146
|
+
/**
|
|
8147
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXXS | `spacingVerticalXXS`} design token.
|
|
8148
|
+
* @public
|
|
8149
|
+
*/
|
|
8150
|
+
export declare const spacingVerticalXXS = "var(--spacingVerticalXXS)";
|
|
8151
|
+
|
|
8152
|
+
/**
|
|
8153
|
+
* CSS custom property value for the {@link @fluentui/tokens#spacingVerticalXXXL | `spacingVerticalXXXL`} design token.
|
|
8154
|
+
* @public
|
|
8155
|
+
*/
|
|
8156
|
+
export declare const spacingVerticalXXXL = "var(--spacingVerticalXXXL)";
|
|
8157
|
+
|
|
8158
|
+
/**
|
|
8159
|
+
* A Spinner Custom HTML Element.
|
|
8160
|
+
* Based on BaseSpinner and includes style and layout specific attributes
|
|
8161
|
+
*
|
|
8162
|
+
* @public
|
|
8163
|
+
*/
|
|
8164
|
+
export declare class Spinner extends BaseSpinner {
|
|
8183
8165
|
/**
|
|
8184
|
-
*
|
|
8166
|
+
* The size of the spinner
|
|
8185
8167
|
*
|
|
8186
8168
|
* @public
|
|
8187
8169
|
* @remarks
|
|
8188
8170
|
* HTML Attribute: size
|
|
8189
|
-
*
|
|
8190
8171
|
*/
|
|
8191
|
-
size?:
|
|
8172
|
+
size?: SpinnerSize;
|
|
8192
8173
|
/**
|
|
8193
8174
|
* Handles changes to size attribute custom states
|
|
8194
8175
|
* @param prev - the previous state
|
|
8195
8176
|
* @param next - the next state
|
|
8196
8177
|
*/
|
|
8197
|
-
sizeChanged(prev:
|
|
8198
|
-
/**
|
|
8199
|
-
* THe Text font
|
|
8200
|
-
*
|
|
8201
|
-
* @public
|
|
8202
|
-
* @remarks
|
|
8203
|
-
* HTML Attribute: font
|
|
8204
|
-
*/
|
|
8205
|
-
font?: TextFont;
|
|
8206
|
-
/**
|
|
8207
|
-
* Handles changes to font attribute custom states
|
|
8208
|
-
* @param prev - the previous state
|
|
8209
|
-
* @param next - the next state
|
|
8210
|
-
*/
|
|
8211
|
-
fontChanged(prev: TextFont | undefined, next: TextFont | undefined): void;
|
|
8212
|
-
/**
|
|
8213
|
-
* The Text weight
|
|
8214
|
-
*
|
|
8215
|
-
* @public
|
|
8216
|
-
* @remarks
|
|
8217
|
-
* HTML Attribute: weight
|
|
8218
|
-
*/
|
|
8219
|
-
weight?: TextWeight;
|
|
8220
|
-
/**
|
|
8221
|
-
* Handles changes to weight attribute custom states
|
|
8222
|
-
* @param prev - the previous state
|
|
8223
|
-
* @param next - the next state
|
|
8224
|
-
*/
|
|
8225
|
-
weightChanged(prev: TextWeight | undefined, next: TextWeight | undefined): void;
|
|
8178
|
+
sizeChanged(prev: SpinnerSize | undefined, next: SpinnerSize | undefined): void;
|
|
8226
8179
|
/**
|
|
8227
|
-
*
|
|
8228
|
-
*
|
|
8180
|
+
* The appearance of the spinner
|
|
8229
8181
|
* @public
|
|
8230
8182
|
* @remarks
|
|
8231
|
-
* HTML Attribute:
|
|
8183
|
+
* HTML Attribute: appearance
|
|
8232
8184
|
*/
|
|
8233
|
-
|
|
8185
|
+
appearance?: SpinnerAppearance;
|
|
8234
8186
|
/**
|
|
8235
|
-
* Handles changes to
|
|
8187
|
+
* Handles changes to appearance attribute custom states
|
|
8236
8188
|
* @param prev - the previous state
|
|
8237
8189
|
* @param next - the next state
|
|
8238
8190
|
*/
|
|
8239
|
-
|
|
8240
|
-
connectedCallback(): void;
|
|
8241
|
-
disconnectedCallback(): void;
|
|
8242
|
-
/**
|
|
8243
|
-
* Handles changes to observable properties
|
|
8244
|
-
* @internal
|
|
8245
|
-
* @param source - the source of the change
|
|
8246
|
-
* @param propertyName - the property name being changed
|
|
8247
|
-
*/
|
|
8248
|
-
handleChange(source: any, propertyName: string): void;
|
|
8191
|
+
appearanceChanged(prev: SpinnerAppearance | undefined, next: SpinnerAppearance | undefined): void;
|
|
8249
8192
|
}
|
|
8250
|
-
export { Text_2 as Text }
|
|
8251
8193
|
|
|
8252
8194
|
/**
|
|
8253
|
-
*
|
|
8195
|
+
* SpinnerAppearance constants
|
|
8254
8196
|
* @public
|
|
8255
8197
|
*/
|
|
8256
|
-
export declare const
|
|
8257
|
-
readonly
|
|
8258
|
-
readonly
|
|
8259
|
-
readonly center: "center";
|
|
8260
|
-
readonly justify: "justify";
|
|
8198
|
+
export declare const SpinnerAppearance: {
|
|
8199
|
+
readonly primary: "primary";
|
|
8200
|
+
readonly inverted: "inverted";
|
|
8261
8201
|
};
|
|
8262
8202
|
|
|
8263
8203
|
/**
|
|
8264
|
-
*
|
|
8204
|
+
* A Spinner's appearance can be either primary or inverted
|
|
8265
8205
|
* @public
|
|
8266
8206
|
*/
|
|
8267
|
-
export declare type
|
|
8207
|
+
export declare type SpinnerAppearance = ValuesOf<typeof SpinnerAppearance>;
|
|
8268
8208
|
|
|
8269
8209
|
/**
|
|
8270
|
-
* The Fluent Text Element.
|
|
8271
|
-
*
|
|
8272
|
-
*
|
|
8273
8210
|
* @public
|
|
8274
8211
|
* @remarks
|
|
8275
|
-
* HTML Element: \<fluent-
|
|
8212
|
+
* HTML Element: \<fluent-spinner\>
|
|
8276
8213
|
*/
|
|
8277
|
-
export declare const
|
|
8214
|
+
export declare const SpinnerDefinition: FASTElementDefinition<typeof Spinner>;
|
|
8278
8215
|
|
|
8279
8216
|
/**
|
|
8280
|
-
*
|
|
8217
|
+
* SpinnerSize constants
|
|
8281
8218
|
* @public
|
|
8282
8219
|
*/
|
|
8283
|
-
export declare const
|
|
8284
|
-
readonly
|
|
8285
|
-
readonly
|
|
8286
|
-
readonly
|
|
8220
|
+
export declare const SpinnerSize: {
|
|
8221
|
+
readonly tiny: "tiny";
|
|
8222
|
+
readonly extraSmall: "extra-small";
|
|
8223
|
+
readonly small: "small";
|
|
8224
|
+
readonly medium: "medium";
|
|
8225
|
+
readonly large: "large";
|
|
8226
|
+
readonly extraLarge: "extra-large";
|
|
8227
|
+
readonly huge: "huge";
|
|
8287
8228
|
};
|
|
8288
8229
|
|
|
8289
8230
|
/**
|
|
8290
|
-
*
|
|
8231
|
+
* A Spinner's size can be either small, tiny, extra-small, medium, large, extra-large, or huge
|
|
8291
8232
|
* @public
|
|
8292
8233
|
*/
|
|
8293
|
-
export declare type
|
|
8234
|
+
export declare type SpinnerSize = ValuesOf<typeof SpinnerSize>;
|
|
8235
|
+
|
|
8236
|
+
export declare const SpinnerStyles: ElementStyles;
|
|
8237
|
+
|
|
8238
|
+
export declare const SpinnerTemplate: ViewTemplate<Spinner, any>;
|
|
8294
8239
|
|
|
8295
8240
|
/**
|
|
8296
|
-
* A
|
|
8297
|
-
*
|
|
8241
|
+
* A mixin class implementing start and end slots.
|
|
8242
|
+
* These are generally used to decorate text elements with icons or other visual indicators.
|
|
8243
|
+
* @public
|
|
8244
|
+
*/
|
|
8245
|
+
declare class StartEnd {
|
|
8246
|
+
start: HTMLSlotElement;
|
|
8247
|
+
end: HTMLSlotElement;
|
|
8248
|
+
}
|
|
8249
|
+
|
|
8250
|
+
/**
|
|
8251
|
+
* Start/End configuration options
|
|
8252
|
+
* @public
|
|
8253
|
+
*/
|
|
8254
|
+
declare type StartEndOptions<TSource = any, TParent = any> = StartOptions<TSource, TParent> & EndOptions<TSource, TParent>;
|
|
8255
|
+
|
|
8256
|
+
/**
|
|
8257
|
+
* Start configuration options
|
|
8258
|
+
* @public
|
|
8259
|
+
*/
|
|
8260
|
+
declare type StartOptions<TSource = any, TParent = any> = {
|
|
8261
|
+
start?: StaticallyComposableHTML<TSource, TParent>;
|
|
8262
|
+
};
|
|
8263
|
+
|
|
8264
|
+
/**
|
|
8265
|
+
* A value that can be statically composed into a
|
|
8266
|
+
* foundation template.
|
|
8267
|
+
* @remarks
|
|
8268
|
+
* When providing a string, take care to ensure that it is
|
|
8269
|
+
* safe and will not enable an XSS attack.
|
|
8270
|
+
* @public
|
|
8271
|
+
*/
|
|
8272
|
+
declare type StaticallyComposableHTML<TSource = any, TParent = any> = string | HTMLDirective | SyntheticViewTemplate<TSource, TParent> | undefined;
|
|
8273
|
+
|
|
8274
|
+
/**
|
|
8275
|
+
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThick | `strokeWidthThick`} design token.
|
|
8276
|
+
* @public
|
|
8277
|
+
*/
|
|
8278
|
+
export declare const strokeWidthThick = "var(--strokeWidthThick)";
|
|
8279
|
+
|
|
8280
|
+
/**
|
|
8281
|
+
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThicker | `strokeWidthThicker`} design token.
|
|
8282
|
+
* @public
|
|
8283
|
+
*/
|
|
8284
|
+
export declare const strokeWidthThicker = "var(--strokeWidthThicker)";
|
|
8285
|
+
|
|
8286
|
+
/**
|
|
8287
|
+
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThickest | `strokeWidthThickest`} design token.
|
|
8288
|
+
* @public
|
|
8289
|
+
*/
|
|
8290
|
+
export declare const strokeWidthThickest = "var(--strokeWidthThickest)";
|
|
8291
|
+
|
|
8292
|
+
/**
|
|
8293
|
+
* CSS custom property value for the {@link @fluentui/tokens#strokeWidthThin | `strokeWidthThin`} design token.
|
|
8294
|
+
* @public
|
|
8295
|
+
*/
|
|
8296
|
+
export declare const strokeWidthThin = "var(--strokeWidthThin)";
|
|
8297
|
+
|
|
8298
|
+
/**
|
|
8299
|
+
* The styles for the Button component.
|
|
8298
8300
|
*
|
|
8299
|
-
* @slot start - Content which can be provided before the input
|
|
8300
|
-
* @slot end - Content which can be provided after the input
|
|
8301
|
-
* @slot - The default slot for button content
|
|
8302
|
-
* @csspart label - The internal `<label>` element
|
|
8303
|
-
* @csspart root - the root container for the internal control
|
|
8304
|
-
* @csspart control - The internal `<input>` control
|
|
8305
8301
|
* @public
|
|
8306
8302
|
*/
|
|
8307
|
-
|
|
8308
|
-
|
|
8309
|
-
|
|
8310
|
-
|
|
8311
|
-
|
|
8312
|
-
|
|
8313
|
-
|
|
8314
|
-
|
|
8315
|
-
|
|
8316
|
-
|
|
8317
|
-
|
|
8318
|
-
|
|
8319
|
-
|
|
8320
|
-
|
|
8321
|
-
|
|
8322
|
-
|
|
8323
|
-
|
|
8324
|
-
|
|
8325
|
-
|
|
8326
|
-
|
|
8327
|
-
|
|
8328
|
-
|
|
8329
|
-
|
|
8330
|
-
|
|
8331
|
-
|
|
8332
|
-
|
|
8333
|
-
|
|
8334
|
-
|
|
8335
|
-
|
|
8336
|
-
|
|
8337
|
-
|
|
8338
|
-
|
|
8339
|
-
|
|
8340
|
-
|
|
8341
|
-
|
|
8342
|
-
|
|
8343
|
-
|
|
8344
|
-
|
|
8345
|
-
|
|
8346
|
-
|
|
8347
|
-
|
|
8348
|
-
|
|
8349
|
-
|
|
8350
|
-
|
|
8351
|
-
|
|
8352
|
-
*/
|
|
8353
|
-
controlSizeChanged(prev: TextInputControlSize | undefined, next: TextInputControlSize | undefined): void;
|
|
8354
|
-
/**
|
|
8355
|
-
* The default slotted content. This is the content that appears in the text field label.
|
|
8356
|
-
*
|
|
8357
|
-
* @internal
|
|
8358
|
-
*/
|
|
8359
|
-
defaultSlottedNodes: Node[];
|
|
8360
|
-
/**
|
|
8361
|
-
* Updates the control label visibility based on the presence of default slotted content.
|
|
8362
|
-
*
|
|
8363
|
-
* @internal
|
|
8364
|
-
*/
|
|
8365
|
-
defaultSlottedNodesChanged(prev: Node[] | undefined, next: Node[] | undefined): void;
|
|
8303
|
+
declare const styles: ElementStyles;
|
|
8304
|
+
export { styles as ButtonStyles }
|
|
8305
|
+
export { styles as MenuButtonStyles }
|
|
8306
|
+
|
|
8307
|
+
export declare class Switch extends BaseCheckbox {
|
|
8308
|
+
constructor();
|
|
8309
|
+
}
|
|
8310
|
+
|
|
8311
|
+
/**
|
|
8312
|
+
* The Fluent Switch Element.
|
|
8313
|
+
*
|
|
8314
|
+
* @public
|
|
8315
|
+
* @remarks
|
|
8316
|
+
* HTML Element: \<fluent-switch\>
|
|
8317
|
+
*/
|
|
8318
|
+
export declare const SwitchDefinition: FASTElementDefinition<typeof Switch>;
|
|
8319
|
+
|
|
8320
|
+
/**
|
|
8321
|
+
* SwitchLabelPosition Constants
|
|
8322
|
+
* @public
|
|
8323
|
+
*/
|
|
8324
|
+
export declare const SwitchLabelPosition: {
|
|
8325
|
+
readonly above: "above";
|
|
8326
|
+
readonly after: "after";
|
|
8327
|
+
readonly before: "before";
|
|
8328
|
+
};
|
|
8329
|
+
|
|
8330
|
+
/**
|
|
8331
|
+
* Applies label position
|
|
8332
|
+
* @public
|
|
8333
|
+
*/
|
|
8334
|
+
export declare type SwitchLabelPosition = ValuesOf<typeof SwitchLabelPosition>;
|
|
8335
|
+
|
|
8336
|
+
export declare type SwitchOptions = {
|
|
8337
|
+
switch?: StaticallyComposableHTML<Switch>;
|
|
8338
|
+
};
|
|
8339
|
+
|
|
8340
|
+
export declare const SwitchStyles: ElementStyles;
|
|
8341
|
+
|
|
8342
|
+
export declare const SwitchTemplate: ElementViewTemplate<Switch>;
|
|
8343
|
+
|
|
8344
|
+
/**
|
|
8345
|
+
* Tab extends the FASTTab and is a child of the TabList
|
|
8346
|
+
*/
|
|
8347
|
+
export declare class Tab extends FASTElement {
|
|
8366
8348
|
/**
|
|
8367
|
-
*
|
|
8368
|
-
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/dirname | `dirname`} attribute
|
|
8369
|
-
*
|
|
8349
|
+
* When true, the control will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute} for more information.
|
|
8370
8350
|
* @public
|
|
8371
8351
|
* @remarks
|
|
8372
|
-
* HTML Attribute:
|
|
8352
|
+
* HTML Attribute: disabled
|
|
8373
8353
|
*/
|
|
8374
|
-
|
|
8354
|
+
disabled: boolean;
|
|
8355
|
+
private styles;
|
|
8356
|
+
connectedCallback(): void;
|
|
8357
|
+
}
|
|
8358
|
+
|
|
8359
|
+
export declare interface Tab extends StartEnd {
|
|
8360
|
+
}
|
|
8361
|
+
|
|
8362
|
+
export declare const TabDefinition: FASTElementDefinition<typeof Tab>;
|
|
8363
|
+
|
|
8364
|
+
/**
|
|
8365
|
+
* Tab configuration options
|
|
8366
|
+
* @public
|
|
8367
|
+
*/
|
|
8368
|
+
export declare type TabOptions = StartEndOptions<Tab>;
|
|
8369
|
+
|
|
8370
|
+
export declare class TabPanel extends FASTElement {
|
|
8371
|
+
}
|
|
8372
|
+
|
|
8373
|
+
export declare const TabPanelDefinition: FASTElementDefinition<typeof TabPanel>;
|
|
8374
|
+
|
|
8375
|
+
export declare const TabPanelStyles: ElementStyles;
|
|
8376
|
+
|
|
8377
|
+
export declare const TabPanelTemplate: ElementViewTemplate<TabPanel, any>;
|
|
8378
|
+
|
|
8379
|
+
export declare class Tabs extends BaseTabs {
|
|
8375
8380
|
/**
|
|
8376
|
-
*
|
|
8377
|
-
*
|
|
8378
|
-
*
|
|
8379
|
-
* @public
|
|
8380
|
-
* @remarks
|
|
8381
|
-
* HTML Attribute: `disabled`
|
|
8381
|
+
* activeTabData
|
|
8382
|
+
* The positional coordinates and size dimensions of the active tab. Used for calculating the offset and scale of the tab active indicator.
|
|
8382
8383
|
*/
|
|
8383
|
-
|
|
8384
|
+
private activeTabData;
|
|
8384
8385
|
/**
|
|
8385
|
-
*
|
|
8386
|
-
*
|
|
8387
|
-
*
|
|
8388
|
-
* @public
|
|
8389
|
-
* @remarks
|
|
8390
|
-
* HTML Attribute: `form`
|
|
8386
|
+
* previousActiveTabData
|
|
8387
|
+
* The positional coordinates and size dimensions of the active tab. Used for calculating the offset and scale of the tab active indicator.
|
|
8391
8388
|
*/
|
|
8392
|
-
|
|
8389
|
+
private previousActiveTabData;
|
|
8393
8390
|
/**
|
|
8394
|
-
*
|
|
8395
|
-
*
|
|
8396
|
-
* @public
|
|
8397
|
-
* @remarks
|
|
8398
|
-
* HTML Attribute: `value`
|
|
8391
|
+
* activeTabOffset
|
|
8392
|
+
* Used to position the active indicator for animations of the active indicator on active tab changes.
|
|
8399
8393
|
*/
|
|
8400
|
-
|
|
8394
|
+
private activeTabOffset;
|
|
8401
8395
|
/**
|
|
8402
|
-
*
|
|
8403
|
-
*
|
|
8404
|
-
* @internal
|
|
8396
|
+
* activeTabScale
|
|
8397
|
+
* Used to scale the tab active indicator up or down as animations of the active indicator occur.
|
|
8405
8398
|
*/
|
|
8406
|
-
|
|
8399
|
+
private activeTabScale;
|
|
8407
8400
|
/**
|
|
8408
|
-
*
|
|
8409
|
-
*
|
|
8410
|
-
*
|
|
8411
|
-
* @public
|
|
8412
|
-
* @remarks
|
|
8413
|
-
* HTML Attribute: `list`
|
|
8401
|
+
* styles
|
|
8402
|
+
* used in the class for storing the css variables required for animations
|
|
8414
8403
|
*/
|
|
8415
|
-
|
|
8404
|
+
private styles;
|
|
8416
8405
|
/**
|
|
8417
|
-
*
|
|
8418
|
-
*
|
|
8419
|
-
* @public
|
|
8420
|
-
* @remarks
|
|
8421
|
-
* HTML Attribute: `maxlength`
|
|
8406
|
+
* appearance
|
|
8407
|
+
* There are two modes of appearance: transparent and subtle.
|
|
8422
8408
|
*/
|
|
8423
|
-
|
|
8409
|
+
appearance?: TabsAppearance;
|
|
8424
8410
|
/**
|
|
8425
|
-
*
|
|
8426
|
-
*
|
|
8427
|
-
*
|
|
8428
|
-
* @public
|
|
8429
|
-
* @remarks
|
|
8430
|
-
* HTML Attribute: `minlength`
|
|
8411
|
+
* disabled
|
|
8412
|
+
* Used for disabling all click and keyboard events for the tabs, child tab elements and tab panel elements. UI styling of content and tabs will appear as "grayed out."
|
|
8431
8413
|
*/
|
|
8432
|
-
|
|
8414
|
+
disabled?: boolean;
|
|
8433
8415
|
/**
|
|
8434
|
-
*
|
|
8435
|
-
*
|
|
8436
|
-
*
|
|
8437
|
-
* @public
|
|
8438
|
-
* @remarks
|
|
8439
|
-
* HTML Attribute: `multiple`
|
|
8416
|
+
* size
|
|
8417
|
+
* defaults to medium.
|
|
8418
|
+
* Used to set the size of all the tab controls, which effects text size and margins. Three sizes: small, medium and large.
|
|
8440
8419
|
*/
|
|
8441
|
-
|
|
8420
|
+
size?: TabsSize;
|
|
8442
8421
|
/**
|
|
8443
|
-
*
|
|
8422
|
+
* calculateAnimationProperties
|
|
8444
8423
|
*
|
|
8445
|
-
*
|
|
8446
|
-
*
|
|
8447
|
-
* HTML Attribute: `name`
|
|
8424
|
+
* Recalculates the active tab offset and scale.
|
|
8425
|
+
* These values will be applied to css variables that control the tab active indicator position animations
|
|
8448
8426
|
*/
|
|
8449
|
-
|
|
8427
|
+
private calculateAnimationProperties;
|
|
8450
8428
|
/**
|
|
8451
|
-
*
|
|
8452
|
-
*
|
|
8453
|
-
* @public
|
|
8454
|
-
* @remarks
|
|
8455
|
-
* HTML Attribute: `pattern`
|
|
8429
|
+
* getSelectedTabPosition - gets the x or y coordinates of the tab
|
|
8456
8430
|
*/
|
|
8457
|
-
|
|
8431
|
+
private getTabPosition;
|
|
8458
8432
|
/**
|
|
8459
|
-
*
|
|
8460
|
-
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/placeholder | `placeholder`} attribute
|
|
8461
|
-
*
|
|
8462
|
-
* @public
|
|
8463
|
-
* @remarks
|
|
8464
|
-
* HTML Attribute: `placeholder`
|
|
8465
|
-
* This attribute is not a valid substitute for a label.
|
|
8433
|
+
* getSelectedTabScale - gets the scale of the tab
|
|
8466
8434
|
*/
|
|
8467
|
-
|
|
8435
|
+
private getTabScale;
|
|
8468
8436
|
/**
|
|
8469
|
-
*
|
|
8470
|
-
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Attributes/readonly | `readonly`} attribute
|
|
8437
|
+
* Calculates and applies updated values to CSS variables.
|
|
8471
8438
|
*
|
|
8472
|
-
* @
|
|
8473
|
-
* @
|
|
8474
|
-
* HTML Attribute: `readonly`
|
|
8439
|
+
* @param tab - the tab element to apply the updated values to
|
|
8440
|
+
* @internal
|
|
8475
8441
|
*/
|
|
8476
|
-
|
|
8442
|
+
private applyUpdatedCSSValues;
|
|
8477
8443
|
/**
|
|
8478
|
-
*
|
|
8444
|
+
* Runs through all the operations required for setting the tab active indicator to its starting location, ending
|
|
8445
|
+
* location, and applying the animated css class to the tab.
|
|
8479
8446
|
*
|
|
8447
|
+
* @param tab - the tab element to apply the updated values to
|
|
8480
8448
|
* @internal
|
|
8481
8449
|
*/
|
|
8482
|
-
|
|
8450
|
+
private animationLoop;
|
|
8483
8451
|
/**
|
|
8484
|
-
*
|
|
8452
|
+
* Sets the data from the active tab onto the class. used for making all the animation calculations for the active
|
|
8453
|
+
* tab indicator.
|
|
8485
8454
|
*
|
|
8486
|
-
* @
|
|
8487
|
-
* @remarks
|
|
8488
|
-
* HTML Attribute: `required`
|
|
8455
|
+
* @internal
|
|
8489
8456
|
*/
|
|
8490
|
-
|
|
8457
|
+
private setTabData;
|
|
8458
|
+
private setTabOffsetCSSVar;
|
|
8459
|
+
private setTabScaleCSSVar;
|
|
8460
|
+
activeidChanged(oldValue: string, newValue: string): void;
|
|
8461
|
+
tabsChanged(): void;
|
|
8462
|
+
}
|
|
8463
|
+
|
|
8464
|
+
export declare interface Tabs extends StartEnd {
|
|
8465
|
+
}
|
|
8466
|
+
|
|
8467
|
+
export declare const TabsAppearance: {
|
|
8468
|
+
readonly subtle: "subtle";
|
|
8469
|
+
readonly transparent: "transparent";
|
|
8470
|
+
};
|
|
8471
|
+
|
|
8472
|
+
export declare type TabsAppearance = ValuesOf<typeof TabsAppearance>;
|
|
8473
|
+
|
|
8474
|
+
export declare const TabsDefinition: FASTElementDefinition<typeof Tabs>;
|
|
8475
|
+
|
|
8476
|
+
/**
|
|
8477
|
+
* Tabs option configuration options
|
|
8478
|
+
* @public
|
|
8479
|
+
*/
|
|
8480
|
+
export declare type TabsOptions = StartEndOptions<Tabs>;
|
|
8481
|
+
|
|
8482
|
+
/**
|
|
8483
|
+
* The orientation of the component
|
|
8484
|
+
* @public
|
|
8485
|
+
*/
|
|
8486
|
+
export declare const TabsOrientation: {
|
|
8487
|
+
readonly horizontal: "horizontal";
|
|
8488
|
+
readonly vertical: "vertical";
|
|
8489
|
+
};
|
|
8490
|
+
|
|
8491
|
+
/**
|
|
8492
|
+
* The types for the Tabs component
|
|
8493
|
+
* @public
|
|
8494
|
+
*/
|
|
8495
|
+
export declare type TabsOrientation = ValuesOf<typeof TabsOrientation>;
|
|
8496
|
+
|
|
8497
|
+
export declare const TabsSize: {
|
|
8498
|
+
readonly small: "small";
|
|
8499
|
+
readonly medium: "medium";
|
|
8500
|
+
readonly large: "large";
|
|
8501
|
+
};
|
|
8502
|
+
|
|
8503
|
+
export declare type TabsSize = ValuesOf<typeof TabsSize>;
|
|
8504
|
+
|
|
8505
|
+
export declare const TabsStyles: ElementStyles;
|
|
8506
|
+
|
|
8507
|
+
export declare const TabsTemplate: ElementViewTemplate<Tabs, any>;
|
|
8508
|
+
|
|
8509
|
+
export declare const TabStyles: ElementStyles;
|
|
8510
|
+
|
|
8511
|
+
export declare const TabTemplate: ElementViewTemplate<Tab, any>;
|
|
8512
|
+
|
|
8513
|
+
/**
|
|
8514
|
+
* The base class used for constructing a fluent-text custom element
|
|
8515
|
+
* @public
|
|
8516
|
+
*/
|
|
8517
|
+
declare class Text_2 extends FASTElement {
|
|
8491
8518
|
/**
|
|
8492
|
-
*
|
|
8493
|
-
*
|
|
8494
|
-
* @param previous - the previous required state
|
|
8495
|
-
* @param next - the current required state
|
|
8519
|
+
* The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
|
|
8496
8520
|
*
|
|
8497
8521
|
* @internal
|
|
8498
8522
|
*/
|
|
8499
|
-
|
|
8523
|
+
elementInternals: ElementInternals;
|
|
8500
8524
|
/**
|
|
8501
|
-
*
|
|
8525
|
+
* The text will not wrap
|
|
8526
|
+
* NOTE: In Fluent UI React v9 this is "wrap"
|
|
8527
|
+
* Boolean attributes which default to true in HTML can't be switched off in the DOM
|
|
8502
8528
|
*
|
|
8503
8529
|
* @public
|
|
8504
8530
|
* @remarks
|
|
8505
|
-
* HTML Attribute:
|
|
8531
|
+
* HTML Attribute: nowrap
|
|
8506
8532
|
*/
|
|
8507
|
-
|
|
8533
|
+
nowrap: boolean;
|
|
8508
8534
|
/**
|
|
8509
|
-
*
|
|
8510
|
-
* @see The {@link https://developer.mozilla.org/docs/Web/HTML/Global_attributes/spellcheck | `spellcheck`} attribute
|
|
8535
|
+
* The text truncates
|
|
8511
8536
|
*
|
|
8512
8537
|
* @public
|
|
8513
8538
|
* @remarks
|
|
8514
|
-
* HTML Attribute:
|
|
8539
|
+
* HTML Attribute: truncate
|
|
8515
8540
|
*/
|
|
8516
|
-
|
|
8541
|
+
truncate: boolean;
|
|
8517
8542
|
/**
|
|
8518
|
-
*
|
|
8543
|
+
* The text style is italic
|
|
8519
8544
|
*
|
|
8520
8545
|
* @public
|
|
8521
8546
|
* @remarks
|
|
8522
|
-
* HTML Attribute:
|
|
8523
|
-
*/
|
|
8524
|
-
type: TextInputType;
|
|
8525
|
-
/**
|
|
8526
|
-
* The current value of the input.
|
|
8527
|
-
*
|
|
8528
|
-
* @internal
|
|
8529
|
-
*/
|
|
8530
|
-
private _value;
|
|
8531
|
-
/**
|
|
8532
|
-
* A reference to the internal input element.
|
|
8533
|
-
*
|
|
8534
|
-
* @internal
|
|
8535
|
-
*/
|
|
8536
|
-
control: HTMLInputElement;
|
|
8537
|
-
/**
|
|
8538
|
-
* A reference to the internal label element.
|
|
8539
|
-
*
|
|
8540
|
-
* @internal
|
|
8541
|
-
*/
|
|
8542
|
-
controlLabel: HTMLLabelElement;
|
|
8543
|
-
/**
|
|
8544
|
-
* Indicates that the value has been changed by the user.
|
|
8545
|
-
*
|
|
8546
|
-
* @internal
|
|
8547
|
-
*/
|
|
8548
|
-
private dirtyValue;
|
|
8549
|
-
/**
|
|
8550
|
-
* The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
|
|
8551
|
-
*
|
|
8552
|
-
* @internal
|
|
8553
|
-
*/
|
|
8554
|
-
elementInternals: ElementInternals;
|
|
8555
|
-
/**
|
|
8556
|
-
* The form-associated flag.
|
|
8557
|
-
* @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements-face-example | Form-associated custom elements}
|
|
8558
|
-
*
|
|
8559
|
-
* @public
|
|
8547
|
+
* HTML Attribute: italic
|
|
8560
8548
|
*/
|
|
8561
|
-
|
|
8549
|
+
italic: boolean;
|
|
8562
8550
|
/**
|
|
8563
|
-
* The
|
|
8551
|
+
* The text style is underline
|
|
8564
8552
|
*
|
|
8565
8553
|
* @public
|
|
8566
8554
|
* @remarks
|
|
8567
|
-
*
|
|
8555
|
+
* HTML Attribute: underline
|
|
8568
8556
|
*/
|
|
8569
|
-
|
|
8557
|
+
underline: boolean;
|
|
8570
8558
|
/**
|
|
8571
|
-
* The
|
|
8559
|
+
* The text style is strikethrough
|
|
8572
8560
|
*
|
|
8573
8561
|
* @public
|
|
8574
8562
|
* @remarks
|
|
8575
|
-
*
|
|
8576
|
-
*/
|
|
8577
|
-
get validationMessage(): string;
|
|
8578
|
-
/**
|
|
8579
|
-
* The current value of the input.
|
|
8580
|
-
* @public
|
|
8563
|
+
* HTML Attribute: strikethrough
|
|
8581
8564
|
*/
|
|
8582
|
-
|
|
8583
|
-
set value(value: string);
|
|
8565
|
+
strikethrough: boolean;
|
|
8584
8566
|
/**
|
|
8585
|
-
*
|
|
8567
|
+
* An text can take up the width of its container.
|
|
8586
8568
|
*
|
|
8587
8569
|
* @public
|
|
8588
8570
|
* @remarks
|
|
8589
|
-
*
|
|
8571
|
+
* HTML Attribute: block
|
|
8590
8572
|
*/
|
|
8591
|
-
|
|
8573
|
+
block: boolean;
|
|
8592
8574
|
/**
|
|
8593
|
-
*
|
|
8575
|
+
* THe Text size
|
|
8594
8576
|
*
|
|
8595
8577
|
* @public
|
|
8596
8578
|
* @remarks
|
|
8597
|
-
*
|
|
8598
|
-
*/
|
|
8599
|
-
get form(): HTMLFormElement | null;
|
|
8600
|
-
/**
|
|
8601
|
-
* Handles the internal control's `keypress` event.
|
|
8579
|
+
* HTML Attribute: size
|
|
8602
8580
|
*
|
|
8603
|
-
* @internal
|
|
8604
8581
|
*/
|
|
8605
|
-
|
|
8582
|
+
size?: TextSize;
|
|
8606
8583
|
/**
|
|
8607
|
-
*
|
|
8608
|
-
*
|
|
8609
|
-
* @
|
|
8610
|
-
* @privateRemarks
|
|
8611
|
-
* "Change" events are not `composable` so they will not permeate the shadow DOM boundary. This function effectively
|
|
8612
|
-
* proxies the change event, emitting a `change` event whenever the internal control emits a `change` event.
|
|
8584
|
+
* Handles changes to size attribute custom states
|
|
8585
|
+
* @param prev - the previous state
|
|
8586
|
+
* @param next - the next state
|
|
8613
8587
|
*/
|
|
8614
|
-
|
|
8588
|
+
sizeChanged(prev: TextSize | undefined, next: TextSize | undefined): void;
|
|
8615
8589
|
/**
|
|
8616
|
-
*
|
|
8590
|
+
* THe Text font
|
|
8617
8591
|
*
|
|
8618
8592
|
* @public
|
|
8619
8593
|
* @remarks
|
|
8620
|
-
*
|
|
8594
|
+
* HTML Attribute: font
|
|
8621
8595
|
*/
|
|
8622
|
-
|
|
8596
|
+
font?: TextFont;
|
|
8623
8597
|
/**
|
|
8624
|
-
*
|
|
8625
|
-
*
|
|
8626
|
-
* @param
|
|
8598
|
+
* Handles changes to font attribute custom states
|
|
8599
|
+
* @param prev - the previous state
|
|
8600
|
+
* @param next - the next state
|
|
8627
8601
|
*/
|
|
8628
|
-
|
|
8629
|
-
connectedCallback(): void;
|
|
8602
|
+
fontChanged(prev: TextFont | undefined, next: TextFont | undefined): void;
|
|
8630
8603
|
/**
|
|
8631
|
-
*
|
|
8604
|
+
* The Text weight
|
|
8632
8605
|
*
|
|
8633
|
-
* @param e - the event object
|
|
8634
8606
|
* @public
|
|
8607
|
+
* @remarks
|
|
8608
|
+
* HTML Attribute: weight
|
|
8635
8609
|
*/
|
|
8636
|
-
|
|
8610
|
+
weight?: TextWeight;
|
|
8637
8611
|
/**
|
|
8638
|
-
*
|
|
8639
|
-
*
|
|
8640
|
-
* @
|
|
8612
|
+
* Handles changes to weight attribute custom states
|
|
8613
|
+
* @param prev - the previous state
|
|
8614
|
+
* @param next - the next state
|
|
8641
8615
|
*/
|
|
8642
|
-
|
|
8616
|
+
weightChanged(prev: TextWeight | undefined, next: TextWeight | undefined): void;
|
|
8643
8617
|
/**
|
|
8644
|
-
*
|
|
8618
|
+
* THe Text align
|
|
8645
8619
|
*
|
|
8646
|
-
* @
|
|
8620
|
+
* @public
|
|
8621
|
+
* @remarks
|
|
8622
|
+
* HTML Attribute: align
|
|
8647
8623
|
*/
|
|
8648
|
-
|
|
8624
|
+
align?: TextAlign;
|
|
8649
8625
|
/**
|
|
8650
|
-
* Handles
|
|
8651
|
-
*
|
|
8652
|
-
* @
|
|
8626
|
+
* Handles changes to align attribute custom states
|
|
8627
|
+
* @param prev - the previous state
|
|
8628
|
+
* @param next - the next state
|
|
8653
8629
|
*/
|
|
8654
|
-
|
|
8630
|
+
alignChanged(prev: TextAlign | undefined, next: TextAlign | undefined): void;
|
|
8631
|
+
connectedCallback(): void;
|
|
8632
|
+
disconnectedCallback(): void;
|
|
8655
8633
|
/**
|
|
8656
|
-
* Handles
|
|
8657
|
-
*
|
|
8658
|
-
* @param e - the event object
|
|
8634
|
+
* Handles changes to observable properties
|
|
8659
8635
|
* @internal
|
|
8636
|
+
* @param source - the source of the change
|
|
8637
|
+
* @param propertyName - the property name being changed
|
|
8660
8638
|
*/
|
|
8661
|
-
|
|
8639
|
+
handleChange(source: any, propertyName: string): void;
|
|
8640
|
+
}
|
|
8641
|
+
export { Text_2 as Text }
|
|
8642
|
+
|
|
8643
|
+
/**
|
|
8644
|
+
* TextAlign Constants
|
|
8645
|
+
* @public
|
|
8646
|
+
*/
|
|
8647
|
+
export declare const TextAlign: {
|
|
8648
|
+
readonly start: "start";
|
|
8649
|
+
readonly end: "end";
|
|
8650
|
+
readonly center: "center";
|
|
8651
|
+
readonly justify: "justify";
|
|
8652
|
+
};
|
|
8653
|
+
|
|
8654
|
+
/**
|
|
8655
|
+
* Aligns the content
|
|
8656
|
+
* @public
|
|
8657
|
+
*/
|
|
8658
|
+
export declare type TextAlign = ValuesOf<typeof TextAlign>;
|
|
8659
|
+
|
|
8660
|
+
/**
|
|
8661
|
+
* The Fluent Text Element.
|
|
8662
|
+
*
|
|
8663
|
+
*
|
|
8664
|
+
* @public
|
|
8665
|
+
* @remarks
|
|
8666
|
+
* HTML Element: \<fluent-text\>
|
|
8667
|
+
*/
|
|
8668
|
+
export declare const TextDefinition: FASTElementDefinition<typeof Text_2>;
|
|
8669
|
+
|
|
8670
|
+
/**
|
|
8671
|
+
* TextFont Constants
|
|
8672
|
+
* @public
|
|
8673
|
+
*/
|
|
8674
|
+
export declare const TextFont: {
|
|
8675
|
+
readonly base: "base";
|
|
8676
|
+
readonly numeric: "numeric";
|
|
8677
|
+
readonly monospace: "monospace";
|
|
8678
|
+
};
|
|
8679
|
+
|
|
8680
|
+
/**
|
|
8681
|
+
* Applies font family to the content
|
|
8682
|
+
* @public
|
|
8683
|
+
*/
|
|
8684
|
+
export declare type TextFont = ValuesOf<typeof TextFont>;
|
|
8685
|
+
|
|
8686
|
+
/**
|
|
8687
|
+
* A Text Input Custom HTML Element.
|
|
8688
|
+
* Based on BaseTextInput and includes style and layout specific attributes
|
|
8689
|
+
*
|
|
8690
|
+
* @public
|
|
8691
|
+
*/
|
|
8692
|
+
export declare class TextInput extends BaseTextInput {
|
|
8662
8693
|
/**
|
|
8663
|
-
*
|
|
8694
|
+
* Indicates the styled appearance of the element.
|
|
8664
8695
|
*
|
|
8665
8696
|
* @public
|
|
8666
|
-
* @
|
|
8667
|
-
*
|
|
8668
|
-
* emitting a `select` event whenever the internal control emits a `select` event
|
|
8669
|
-
*
|
|
8697
|
+
* @remarks
|
|
8698
|
+
* HTML Attribute: `appearance`
|
|
8670
8699
|
*/
|
|
8671
|
-
|
|
8700
|
+
appearance?: TextInputAppearance;
|
|
8672
8701
|
/**
|
|
8673
|
-
*
|
|
8674
|
-
* @param
|
|
8675
|
-
*
|
|
8676
|
-
* @public
|
|
8702
|
+
* Handles changes to appearance attribute custom states
|
|
8703
|
+
* @param prev - the previous state
|
|
8704
|
+
* @param next - the next state
|
|
8677
8705
|
*/
|
|
8678
|
-
|
|
8706
|
+
appearanceChanged(prev: TextInputAppearance | undefined, next: TextInputAppearance | undefined): void;
|
|
8679
8707
|
/**
|
|
8680
|
-
*
|
|
8708
|
+
* Sets the size of the control.
|
|
8681
8709
|
*
|
|
8682
8710
|
* @public
|
|
8683
8711
|
* @remarks
|
|
8684
|
-
*
|
|
8685
|
-
*/
|
|
8686
|
-
reportValidity(): boolean;
|
|
8687
|
-
/**
|
|
8688
|
-
* Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/setFormValue | `ElementInternals.setFormValue()`} method.
|
|
8689
|
-
*
|
|
8690
|
-
* @internal
|
|
8712
|
+
* HTML Attribute: `control-size`
|
|
8691
8713
|
*/
|
|
8692
|
-
|
|
8714
|
+
controlSize?: TextInputControlSize;
|
|
8693
8715
|
/**
|
|
8694
|
-
*
|
|
8695
|
-
*
|
|
8696
|
-
* @param
|
|
8697
|
-
* @param message - Optional message to supply. If not provided, the control's `validationMessage` will be used. If the control does not have a `validationMessage`, the message will be empty.
|
|
8698
|
-
* @param anchor - Optional anchor to use for the validation message. If not provided, the control will be used.
|
|
8699
|
-
*
|
|
8700
|
-
* @internal
|
|
8716
|
+
* Handles changes to `control-size` attribute custom states
|
|
8717
|
+
* @param prev - the previous state
|
|
8718
|
+
* @param next - the next state
|
|
8701
8719
|
*/
|
|
8702
|
-
|
|
8720
|
+
controlSizeChanged(prev: TextInputControlSize | undefined, next: TextInputControlSize | undefined): void;
|
|
8703
8721
|
}
|
|
8704
8722
|
|
|
8705
8723
|
/**
|