Update jsdocs

Author: mj12albert

docs/reference/generated/toggle-group.json

@@ -4,15 +4,15 @@
   "props": {
     "defaultValue": {
       "type": "any[]",
-      "description": "The open state of the ToggleGroup represented by an array of\nthe values of all pressed toggle buttons.\nThis is the uncontrolled counterpart of `value`."
+      "description": "The open state of the toggle group represented by an array of\nthe values of all pressed toggle buttons.\nThis is the uncontrolled counterpart of `value`."
     },
     "value": {
       "type": "any[]",
-      "description": "The open state of the ToggleGroup represented by an array of\nthe values of all pressed toggle buttons\nThis is the controlled counterpart of `defaultValue`."
+      "description": "The open state of the toggle group represented by an array of\nthe values of all pressed toggle buttons.\nThis is the controlled counterpart of `defaultValue`."
     },
     "onValueChange": {
       "type": "((groupValue: any[], event: Event) => void)",
-      "description": "Callback fired when the pressed states of the ToggleGroup changes."
+      "description": "Callback fired when the pressed states of the toggle group changes."
     },
     "toggleMultiple": {
       "type": "boolean",
@@ -22,7 +22,7 @@
     "disabled": {
       "type": "boolean",
       "default": "false",
-      "description": "Whether the component should ignore user interaction."
+      "description": "Whether the toggle group should ignore user interaction."
     },
     "loop": {
       "type": "boolean",

docs/reference/generated/toggle.json

@@ -4,16 +4,16 @@
   "props": {
     "value": {
       "type": "string",
-      "description": "A unique string that identifies the component when used\ninside a ToggleGroup."
+      "description": "A unique string that identifies the toggle when used\ninside a toggle group."
     },
     "defaultPressed": {
       "type": "boolean",
       "default": "false",
-      "description": "The default pressed state. Use when the component is not controlled."
+      "description": "Whether the toggle button is currently pressed.\nThis is the uncontrolled counterpart of `pressed`."
     },
     "pressed": {
       "type": "boolean",
-      "description": "Whether the toggle button is currently active."
+      "description": "Whether the toggle button is currently pressed.\nThis is the controlled counterpart of `defaultPressed`."
     },
     "onPressedChange": {
       "type": "((pressed: boolean, event: Event) => void)",

packages/react/src/toggle-group/ToggleGroup.tsx

@@ -132,26 +132,26 @@ namespace ToggleGroup {
 
   export interface Props extends Omit<BaseUIComponentProps<'div', State>, 'defaultValue'> {
     /**
-     * The open state of the ToggleGroup represented by an array of
-     * the values of all pressed toggle buttons
+     * The open state of the toggle group represented by an array of
+     * the values of all pressed toggle buttons.
      * This is the controlled counterpart of `defaultValue`.
      */
     value?: readonly any[];
     /**
-     * The open state of the ToggleGroup represented by an array of
+     * The open state of the toggle group represented by an array of
      * the values of all pressed toggle buttons.
      * This is the uncontrolled counterpart of `value`.
      */
     defaultValue?: readonly any[];
     /**
-     * Callback fired when the pressed states of the ToggleGroup changes.
+     * Callback fired when the pressed states of the toggle group changes.
      *
      * @param {any[]} groupValue An array of the `value`s of all the pressed items.
      * @param {Event} event The corresponding event that initiated the change.
      */
     onValueChange?: (groupValue: any[], event: Event) => void;
     /**
-     * Whether the component should ignore user interaction.
+     * Whether the toggle group should ignore user interaction.
      * @default false
      */
     disabled?: boolean;
@@ -190,13 +190,13 @@ ToggleGroup.propTypes /* remove-proptypes */ = {
    */
   className: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
   /**
-   * The open state of the ToggleGroup represented by an array of
+   * The open state of the toggle group represented by an array of
    * the values of all pressed toggle buttons.
    * This is the uncontrolled counterpart of `value`.
    */
   defaultValue: PropTypes.array,
   /**
-   * Whether the component should ignore user interaction.
+   * Whether the toggle group should ignore user interaction.
    * @default false
    */
   disabled: PropTypes.bool,
@@ -207,7 +207,7 @@ ToggleGroup.propTypes /* remove-proptypes */ = {
    */
   loop: PropTypes.bool,
   /**
-   * Callback fired when the pressed states of the ToggleGroup changes.
+   * Callback fired when the pressed states of the toggle group changes.
    *
    * @param {any[]} groupValue An array of the `value`s of all the pressed items.
    * @param {Event} event The corresponding event that initiated the change.
@@ -232,8 +232,8 @@ ToggleGroup.propTypes /* remove-proptypes */ = {
    */
   toggleMultiple: PropTypes.bool,
   /**
-   * The open state of the ToggleGroup represented by an array of
-   * the values of all pressed toggle buttons
+   * The open state of the toggle group represented by an array of
+   * the values of all pressed toggle buttons.
    * This is the controlled counterpart of `defaultValue`.
    */
   value: PropTypes.array,

packages/react/src/toggle/Toggle.tsx

@@ -104,11 +104,13 @@ namespace Toggle {
 
   export interface Props extends Omit<BaseUIComponentProps<'button', State>, 'value'> {
     /**
-     * Whether the toggle button is currently active.
+     * Whether the toggle button is currently pressed.
+     * This is the controlled counterpart of `defaultPressed`.
      */
     pressed?: boolean;
     /**
-     * The default pressed state. Use when the component is not controlled.
+     * Whether the toggle button is currently pressed.
+     * This is the uncontrolled counterpart of `pressed`.
      * @default false
      */
     defaultPressed?: boolean;
@@ -125,8 +127,8 @@ namespace Toggle {
      */
     onPressedChange?: (pressed: boolean, event: Event) => void;
     /**
-     * A unique string that identifies the component when used
-     * inside a ToggleGroup.
+     * A unique string that identifies the toggle when used
+     * inside a toggle group.
      */
     value?: string;
   }
@@ -147,7 +149,8 @@ Toggle.propTypes /* remove-proptypes */ = {
    */
   className: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
   /**
-   * The default pressed state. Use when the component is not controlled.
+   * Whether the toggle button is currently pressed.
+   * This is the uncontrolled counterpart of `pressed`.
    * @default false
    */
   defaultPressed: PropTypes.bool,
@@ -168,7 +171,8 @@ Toggle.propTypes /* remove-proptypes */ = {
    */
   onPressedChange: PropTypes.func,
   /**
-   * Whether the toggle button is currently active.
+   * Whether the toggle button is currently pressed.
+   * This is the controlled counterpart of `defaultPressed`.
    */
   pressed: PropTypes.bool,
   /**
@@ -183,8 +187,8 @@ Toggle.propTypes /* remove-proptypes */ = {
    */
   type: PropTypes.oneOf(['button', 'reset', 'submit']),
   /**
-   * A unique string that identifies the component when used
-   * inside a ToggleGroup.
+   * A unique string that identifies the toggle when used
+   * inside a toggle group.
    */
   value: PropTypes.string,
 } as any;