@fluentui/react-label 9.0.0-beta.11 → 9.0.0-beta.12

Sign up to get free protection for your applications and to get access to all the features.
package/CHANGELOG.json CHANGED
@@ -2,7 +2,42 @@
2
2
  "name": "@fluentui/react-label",
3
3
  "entries": [
4
4
  {
5
- "date": "Wed, 04 May 2022 13:24:11 GMT",
5
+ "date": "Thu, 05 May 2022 18:24:31 GMT",
6
+ "tag": "@fluentui/react-label_v9.0.0-beta.12",
7
+ "version": "9.0.0-beta.12",
8
+ "comments": {
9
+ "none": [
10
+ {
11
+ "author": "esteban.230@hotmail.com",
12
+ "package": "@fluentui/react-label",
13
+ "commit": "700e11e12b3e06cb10a0196e91e64b5ee4867405",
14
+ "comment": "Updating spec, fixing typos in types, and adding descriptions in stories."
15
+ }
16
+ ],
17
+ "prerelease": [
18
+ {
19
+ "author": "beachball",
20
+ "package": "@fluentui/react-label",
21
+ "comment": "Bump @fluentui/react-theme to v9.0.0-rc.7",
22
+ "commit": "c5abb9c480ac94d12aa644d68d30773d77f2a159"
23
+ },
24
+ {
25
+ "author": "beachball",
26
+ "package": "@fluentui/react-label",
27
+ "comment": "Bump @fluentui/react-utilities to v9.0.0-rc.8",
28
+ "commit": "c5abb9c480ac94d12aa644d68d30773d77f2a159"
29
+ },
30
+ {
31
+ "author": "beachball",
32
+ "package": "@fluentui/react-label",
33
+ "comment": "Bump @fluentui/react-conformance-griffel to v9.0.0-beta.5",
34
+ "commit": "c5abb9c480ac94d12aa644d68d30773d77f2a159"
35
+ }
36
+ ]
37
+ }
38
+ },
39
+ {
40
+ "date": "Wed, 04 May 2022 13:26:43 GMT",
6
41
  "tag": "@fluentui/react-label_v9.0.0-beta.11",
7
42
  "version": "9.0.0-beta.11",
8
43
  "comments": {
package/CHANGELOG.md CHANGED
@@ -1,12 +1,23 @@
1
1
  # Change Log - @fluentui/react-label
2
2
 
3
- This log was last generated on Wed, 04 May 2022 13:24:11 GMT and should not be manually modified.
3
+ This log was last generated on Thu, 05 May 2022 18:24:31 GMT and should not be manually modified.
4
4
 
5
5
  <!-- Start content -->
6
6
 
7
+ ## [9.0.0-beta.12](https://github.com/microsoft/fluentui/tree/@fluentui/react-label_v9.0.0-beta.12)
8
+
9
+ Thu, 05 May 2022 18:24:31 GMT
10
+ [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-label_v9.0.0-beta.11..@fluentui/react-label_v9.0.0-beta.12)
11
+
12
+ ### Changes
13
+
14
+ - Bump @fluentui/react-theme to v9.0.0-rc.7 ([PR #22857](https://github.com/microsoft/fluentui/pull/22857) by beachball)
15
+ - Bump @fluentui/react-utilities to v9.0.0-rc.8 ([PR #22857](https://github.com/microsoft/fluentui/pull/22857) by beachball)
16
+ - Bump @fluentui/react-conformance-griffel to v9.0.0-beta.5 ([PR #22857](https://github.com/microsoft/fluentui/pull/22857) by beachball)
17
+
7
18
  ## [9.0.0-beta.11](https://github.com/microsoft/fluentui/tree/@fluentui/react-label_v9.0.0-beta.11)
8
19
 
9
- Wed, 04 May 2022 13:24:11 GMT
20
+ Wed, 04 May 2022 13:26:43 GMT
10
21
  [Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-label_v9.0.0-beta.10..@fluentui/react-label_v9.0.0-beta.11)
11
22
 
12
23
  ### Changes
package/Spec.md CHANGED
@@ -78,19 +78,19 @@ The Label component should be simple as shown below. It will just need the text
78
78
  export type LabelCommons = {
79
79
  /**
80
80
  * Renders the label as disabled
81
- * @defaultvalue false
81
+ * @default false
82
82
  */
83
83
  disabled: boolean;
84
84
 
85
85
  /**
86
86
  * A label supports different sizes.
87
- * @defaultvalue 'medium'
87
+ * @default 'medium'
88
88
  */
89
89
  size: 'small' | 'medium' | 'large';
90
90
 
91
91
  /**
92
92
  * A label supports semibold/strong fontweight.
93
- * @defaultvalue false
93
+ * @default false
94
94
  */
95
95
  strong: boolean;
96
96
  };
@@ -111,11 +111,11 @@ export type LabelState = ComponentState<LabelSlots> & LabelCommons;
111
111
  export type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> &
112
112
  Partial<LabelCommons> & {
113
113
  /**
114
- * Displays and indicator that the label is for a required field. The required prop can be set to true to display
114
+ * Displays an indicator that the label is for a required field. The required prop can be set to true to display
115
115
  * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
116
- * @defaultvalue false
116
+ * @default false
117
117
  */
118
- required?: boolean | IntrinsicSlotProps<'span'> | React.ReactNode;
118
+ required?: boolean | Slot<'span'>;
119
119
  };
120
120
  ```
121
121
 
@@ -166,3 +166,4 @@ _Keyboard, Cursor, Touch, and Screen Readers_
166
166
  - Label will use the native `label` element to render.
167
167
  - Label cannot receive focus.
168
168
  - Label will have no focusable elements.
169
+ - When a Label is disabled, the required contrast ratio won't be met. This is acceptable behavior due to the nature of the styling. This state should be used sparingly and make it clear that there's no interaction with the control associated with it.
package/dist/index.d.ts CHANGED
@@ -20,17 +20,17 @@ export declare const labelClassNames: SlotClassNames<LabelSlots>;
20
20
  declare type LabelCommons = {
21
21
  /**
22
22
  * Renders the label as disabled
23
- * @defaultvalue false
23
+ * @default false
24
24
  */
25
25
  disabled: boolean;
26
26
  /**
27
27
  * A label supports different sizes.
28
- * @defaultvalue 'medium'
28
+ * @default 'medium'
29
29
  */
30
30
  size: 'small' | 'medium' | 'large';
31
31
  /**
32
32
  * A label supports semibold/strong fontweight.
33
- * @defaultvalue false
33
+ * @default false
34
34
  */
35
35
  strong: boolean;
36
36
  };
@@ -40,9 +40,9 @@ declare type LabelCommons = {
40
40
  */
41
41
  export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & Partial<LabelCommons> & {
42
42
  /**
43
- * Displays and indicator that the label is for a required field. The required prop can be set to true to display
43
+ * Displays an indicator that the label is for a required field. The required prop can be set to true to display
44
44
  * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
45
- * @defaultvalue false
45
+ * @default false
46
46
  */
47
47
  required?: boolean | Slot<'span'>;
48
48
  };
@@ -2,17 +2,17 @@ import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utili
2
2
  declare type LabelCommons = {
3
3
  /**
4
4
  * Renders the label as disabled
5
- * @defaultvalue false
5
+ * @default false
6
6
  */
7
7
  disabled: boolean;
8
8
  /**
9
9
  * A label supports different sizes.
10
- * @defaultvalue 'medium'
10
+ * @default 'medium'
11
11
  */
12
12
  size: 'small' | 'medium' | 'large';
13
13
  /**
14
14
  * A label supports semibold/strong fontweight.
15
- * @defaultvalue false
15
+ * @default false
16
16
  */
17
17
  strong: boolean;
18
18
  };
@@ -29,9 +29,9 @@ export declare type LabelState = ComponentState<LabelSlots> & LabelCommons;
29
29
  */
30
30
  export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & Partial<LabelCommons> & {
31
31
  /**
32
- * Displays and indicator that the label is for a required field. The required prop can be set to true to display
32
+ * Displays an indicator that the label is for a required field. The required prop can be set to true to display
33
33
  * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
34
- * @defaultvalue false
34
+ * @default false
35
35
  */
36
36
  required?: boolean | Slot<'span'>;
37
37
  };
@@ -1 +1 @@
1
- {"version":3,"file":"Label.types.js","sourceRoot":"../src/","sources":["components/Label/Label.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\n\ntype LabelCommons = {\n /**\n * Renders the label as disabled\n * @defaultvalue false\n */\n disabled: boolean;\n\n /**\n * A label supports different sizes.\n * @defaultvalue 'medium'\n */\n size: 'small' | 'medium' | 'large';\n\n /**\n * A label supports semibold/strong fontweight.\n * @defaultvalue false\n */\n strong: boolean;\n};\n\nexport type LabelSlots = {\n root: Slot<'label'>;\n required?: Slot<'span'>;\n};\n\n/**\n * State used in rendering Label\n */\nexport type LabelState = ComponentState<LabelSlots> & LabelCommons;\n\n/**\n * Label Props\n */\nexport type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> &\n Partial<LabelCommons> & {\n /**\n * Displays and indicator that the label is for a required field. The required prop can be set to true to display\n * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.\n * @defaultvalue false\n */\n required?: boolean | Slot<'span'>;\n };\n"]}
1
+ {"version":3,"file":"Label.types.js","sourceRoot":"../src/","sources":["components/Label/Label.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\n\ntype LabelCommons = {\n /**\n * Renders the label as disabled\n * @default false\n */\n disabled: boolean;\n\n /**\n * A label supports different sizes.\n * @default 'medium'\n */\n size: 'small' | 'medium' | 'large';\n\n /**\n * A label supports semibold/strong fontweight.\n * @default false\n */\n strong: boolean;\n};\n\nexport type LabelSlots = {\n root: Slot<'label'>;\n required?: Slot<'span'>;\n};\n\n/**\n * State used in rendering Label\n */\nexport type LabelState = ComponentState<LabelSlots> & LabelCommons;\n\n/**\n * Label Props\n */\nexport type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> &\n Partial<LabelCommons> & {\n /**\n * Displays an indicator that the label is for a required field. The required prop can be set to true to display\n * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.\n * @default false\n */\n required?: boolean | Slot<'span'>;\n };\n"]}
@@ -2,17 +2,17 @@ import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utili
2
2
  declare type LabelCommons = {
3
3
  /**
4
4
  * Renders the label as disabled
5
- * @defaultvalue false
5
+ * @default false
6
6
  */
7
7
  disabled: boolean;
8
8
  /**
9
9
  * A label supports different sizes.
10
- * @defaultvalue 'medium'
10
+ * @default 'medium'
11
11
  */
12
12
  size: 'small' | 'medium' | 'large';
13
13
  /**
14
14
  * A label supports semibold/strong fontweight.
15
- * @defaultvalue false
15
+ * @default false
16
16
  */
17
17
  strong: boolean;
18
18
  };
@@ -29,9 +29,9 @@ export declare type LabelState = ComponentState<LabelSlots> & LabelCommons;
29
29
  */
30
30
  export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & Partial<LabelCommons> & {
31
31
  /**
32
- * Displays and indicator that the label is for a required field. The required prop can be set to true to display
32
+ * Displays an indicator that the label is for a required field. The required prop can be set to true to display
33
33
  * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
34
- * @defaultvalue false
34
+ * @default false
35
35
  */
36
36
  required?: boolean | Slot<'span'>;
37
37
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluentui/react-label",
3
- "version": "9.0.0-beta.11",
3
+ "version": "9.0.0-beta.12",
4
4
  "description": "Fluent UI React Label component",
5
5
  "main": "lib-commonjs/index.js",
6
6
  "module": "lib/index.js",
@@ -28,12 +28,12 @@
28
28
  "devDependencies": {
29
29
  "@fluentui/eslint-plugin": "*",
30
30
  "@fluentui/react-conformance": "*",
31
- "@fluentui/react-conformance-griffel": "9.0.0-beta.4",
31
+ "@fluentui/react-conformance-griffel": "9.0.0-beta.5",
32
32
  "@fluentui/scripts": "^1.0.0"
33
33
  },
34
34
  "dependencies": {
35
- "@fluentui/react-theme": "9.0.0-rc.6",
36
- "@fluentui/react-utilities": "9.0.0-rc.7",
35
+ "@fluentui/react-theme": "9.0.0-rc.7",
36
+ "@fluentui/react-utilities": "9.0.0-rc.8",
37
37
  "@griffel/react": "1.0.3",
38
38
  "tslib": "^2.1.0"
39
39
  },