@fluentui/react-label - npm Package Compare versions

Comparing version 0.0.0-nightly-20220506-0417.1 to 0.0.0-nightly-20220509-0421.1

CHANGELOG.md

 # Change Log - @fluentui/react-label
 
-This log was last generated on Fri, 06 May 2022 04:27:19 GMT and should not be manually modified.
+This log was last generated on Mon, 09 May 2022 04:32:18 GMT and should not be manually modified.
 
 <!-- Start content -->
 
-## [0.0.0-nightly-20220506-0417.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-label_v0.0.0-nightly-20220506-0417.1)
+## [0.0.0-nightly-20220509-0421.1](https://github.com/microsoft/fluentui/tree/@fluentui/react-label_v0.0.0-nightly-20220509-0421.1)
 
-Fri, 06 May 2022 04:27:19 GMT 
-[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-label_v9.0.0-beta.12..@fluentui/react-label_v0.0.0-nightly-20220506-0417.1)
+Mon, 09 May 2022 04:32:18 GMT 
+[Compare changes](https://github.com/microsoft/fluentui/compare/@fluentui/react-label_v9.0.0-beta.12..@fluentui/react-label_v0.0.0-nightly-20220509-0421.1)
 
@@ -15,5 +15,7 @@ ### Changes
 - Release nightly v9 ([commit](https://github.com/microsoft/fluentui/commit/not available) by email not defined)
-- Bump @fluentui/react-theme to v0.0.0-nightly-20220506-0417.1 ([commit](https://github.com/microsoft/fluentui/commit/1dbdfe3544ed01dff3baaf5d6b96d3cc8ec5e559) by beachball)
-- Bump @fluentui/react-utilities to v0.0.0-nightly-20220506-0417.1 ([commit](https://github.com/microsoft/fluentui/commit/1dbdfe3544ed01dff3baaf5d6b96d3cc8ec5e559) by beachball)
-- Bump @fluentui/react-conformance-griffel to v0.0.0-nightly-20220506-0417.1 ([commit](https://github.com/microsoft/fluentui/commit/1dbdfe3544ed01dff3baaf5d6b96d3cc8ec5e559) by beachball)
+- update README and package version ([PR #22865](https://github.com/microsoft/fluentui/pull/22865) by [e-mail])
+- Removing commons type from Label. ([PR #22880](https://github.com/microsoft/fluentui/pull/22880) by [e-mail])
+- Bump @fluentui/react-theme to v0.0.0-nightly-20220509-0421.1 ([commit](https://github.com/microsoft/fluentui/commit/bfa631b1a1c5b024e734a24fb8d3f53e51f97f75) by beachball)
+- Bump @fluentui/react-utilities to v0.0.0-nightly-20220509-0421.1 ([commit](https://github.com/microsoft/fluentui/commit/bfa631b1a1c5b024e734a24fb8d3f53e51f97f75) by beachball)
+- Bump @fluentui/react-conformance-griffel to v0.0.0-nightly-20220509-0421.1 ([commit](https://github.com/microsoft/fluentui/commit/bfa631b1a1c5b024e734a24fb8d3f53e51f97f75) by beachball)
 
@@ -20,0 +22,0 @@ ## [9.0.0-beta.12](https://github.com/microsoft/fluentui/tree/@fluentui/react-label_v9.0.0-beta.12)

dist/index.d.ts

@@ -20,3 +20,6 @@ import type { ComponentProps } from '@fluentui/react-utilities';
 
-declare type LabelCommons = {
+/**
+ * Label Props
+ */
+export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & {
     /**
@@ -26,8 +29,14 @@ * Renders the label as disabled
      */
-    disabled: boolean;
+    disabled?: boolean;
     /**
+     * Displays an indicator that the label is for a required field. The required prop can be set to true to display
+     * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
+     * @default false
+     */
+    required?: boolean | Slot<'span'>;
+    /**
      * A label supports different sizes.
      * @default 'medium'
      */
-    size: 'small' | 'medium' | 'large';
+    size?: 'small' | 'medium' | 'large';
     /**
@@ -37,17 +46,5 @@ * A label supports semibold/strong fontweight.
      */
-    strong: boolean;
+    strong?: boolean;
 };
 
-/**
- * Label Props
- */
-export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & Partial<LabelCommons> & {
-    /**
-     * Displays an indicator that the label is for a required field. The required prop can be set to true to display
-     * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
-     * @default false
-     */
-    required?: boolean | Slot<'span'>;
-};
-
 export declare type LabelSlots = {
@@ -61,3 +58,3 @@ root: Slot<'label'>;
  */
-export declare type LabelState = ComponentState<LabelSlots> & LabelCommons;
+export declare type LabelState = ComponentState<LabelSlots> & Required<Pick<LabelProps, 'disabled' | 'size' | 'strong'>>;
 
@@ -64,0 +61,0 @@ /**

lib-commonjs/components/Label/Label.types.d.ts

 import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-declare type LabelCommons = {
+/**
+ * Label Props
+ */
+export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & {
     /**
@@ -7,8 +10,14 @@ * Renders the label as disabled
      */
-    disabled: boolean;
+    disabled?: boolean;
     /**
+     * Displays an indicator that the label is for a required field. The required prop can be set to true to display
+     * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
+     * @default false
+     */
+    required?: boolean | Slot<'span'>;
+    /**
      * A label supports different sizes.
      * @default 'medium'
      */
-    size: 'small' | 'medium' | 'large';
+    size?: 'small' | 'medium' | 'large';
     /**
@@ -18,3 +27,3 @@ * A label supports semibold/strong fontweight.
      */
-    strong: boolean;
+    strong?: boolean;
 };
@@ -28,14 +37,2 @@ export declare type LabelSlots = {
  */
-export declare type LabelState = ComponentState<LabelSlots> & LabelCommons;
-/**
- * Label Props
- */
-export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & Partial<LabelCommons> & {
-    /**
-     * Displays an indicator that the label is for a required field. The required prop can be set to true to display
-     * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
-     * @default false
-     */
-    required?: boolean | Slot<'span'>;
-};
-export {};
+export declare type LabelState = ComponentState<LabelSlots> & Required<Pick<LabelProps, 'disabled' | 'size' | 'strong'>>;

lib/components/Label/Label.types.d.ts

 import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
-declare type LabelCommons = {
+/**
+ * Label Props
+ */
+export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & {
     /**
@@ -7,8 +10,14 @@ * Renders the label as disabled
      */
-    disabled: boolean;
+    disabled?: boolean;
     /**
+     * Displays an indicator that the label is for a required field. The required prop can be set to true to display
+     * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
+     * @default false
+     */
+    required?: boolean | Slot<'span'>;
+    /**
      * A label supports different sizes.
      * @default 'medium'
      */
-    size: 'small' | 'medium' | 'large';
+    size?: 'small' | 'medium' | 'large';
     /**
@@ -18,3 +27,3 @@ * A label supports semibold/strong fontweight.
      */
-    strong: boolean;
+    strong?: boolean;
 };
@@ -28,14 +37,2 @@ export declare type LabelSlots = {
  */
-export declare type LabelState = ComponentState<LabelSlots> & LabelCommons;
-/**
- * Label Props
- */
-export declare type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & Partial<LabelCommons> & {
-    /**
-     * Displays an indicator that the label is for a required field. The required prop can be set to true to display
-     * an asterisk (*). Or it can be set to a string or jsx content to display a different indicator.
-     * @default false
-     */
-    required?: boolean | Slot<'span'>;
-};
-export {};
+export declare type LabelState = ComponentState<LabelSlots> & Required<Pick<LabelProps, 'disabled' | 'size' | 'strong'>>;

package.json

 {
   "name": "@fluentui/react-label",
-  "version": "0.0.0-nightly-20220506-0417.1",
+  "version": "0.0.0-nightly-20220509-0421.1",
   "description": "Fluent UI React Label component",
@@ -31,8 +31,8 @@ "main": "lib-commonjs/index.js",
     "@fluentui/react-conformance": "*",
-    "@fluentui/react-conformance-griffel": "0.0.0-nightly-20220506-0417.1",
+    "@fluentui/react-conformance-griffel": "0.0.0-nightly-20220509-0421.1",
     "@fluentui/scripts": "^1.0.0"
   },
   "dependencies": {
-    "@fluentui/react-theme": "0.0.0-nightly-20220506-0417.1",
-    "@fluentui/react-utilities": "0.0.0-nightly-20220506-0417.1",
+    "@fluentui/react-theme": "0.0.0-nightly-20220509-0421.1",
+    "@fluentui/react-utilities": "0.0.0-nightly-20220509-0421.1",
     "@griffel/react": "1.0.3",
@@ -39,0 +39,0 @@ "tslib": "^2.1.0"

README.md

@@ -7,9 +7,11 @@ # @fluentui/react-label
 
+Labels provide a name or title to a component or group of components, e.g., text fields, checkboxes, radio buttons, and dropdown menus.
+
 ## Usage
 
-To use the `Label` component import it from `@fluentui/react-label` and use it as shown below.
+To use the `Label` component import it from `@fluentui/react-components` and use it as shown below.
 
 ```tsx
 import * as React from 'react';
-import { Label } from '@fluentui/react-label';
+import { Label } from '@fluentui/react-components';
 import { useId } from '@fluentui/react-utilities';
@@ -30,1 +32,12 @@
 ```
+
+See [Fluent UI Storybook](https://aka.ms/fluentui-storybook) for more detailed usage examples.
+
+Alternatively, run Storybook locally with:
+
+1. `yarn start`
+2. Select `react-label` from the list.
+
+### Specification
+
+See [Spec.md](./Spec.md).

No alert changes

Improved metrics

Total package byte prevSize

160312

increased by0.67%

Lines of code

2552

increased by0.16%

Number of lines in readme file

42

increased by44.83%

Dependency changes

• + Added@fluentui/keyboard-keys@0.0.0-nightly-20220509-0421.1(transitive)

• + Added@fluentui/react-theme@0.0.0-nightly-20220509-0421.1(transitive)

• + Added@fluentui/react-utilities@0.0.0-nightly-20220509-0421.1(transitive)

• - Removed@fluentui/keyboard-keys@0.0.0-nightly-20220506-0417.1(transitive)

• - Removed@fluentui/react-theme@0.0.0-nightly-20220506-0417.1(transitive)

• - Removed@fluentui/react-utilities@0.0.0-nightly-20220506-0417.1(transitive)

• Updated@fluentui/react-theme@0.0.0-nightly-20220509-0421.1

• Updated@fluentui/react-utilities@0.0.0-nightly-20220509-0421.1