@akinon/ui-checkbox 0.5.0 → 1.0.0

package/dist/cjs/index.d.ts

@@ -1,6 +1,31 @@
 import * as React from 'react';
 import type { CheckboxGroupProps, CheckboxProps } from './types';
+/**
+ * Checkbox component for Akinon UI.
+ *
+ * This component provides a versatile checkbox implementation, supporting both standalone usage
+ * and grouped configurations (via CheckboxGroup). It offers flexibility with various states,
+ * event handlers, and accessibility features.
+ *
+ * The Checkbox component adheres to the Akinon design system, ensuring consistent behavior
+ * and appearance. Custom styles are not permitted to maintain design integrity.
+ *
+ * For group usage, refer to the CheckboxGroup, which manages multiple checkboxes and their states.
+ */
 export declare const Checkbox: ({ children, ...restCheckboxProps }: CheckboxProps) => React.JSX.Element;
+/**
+ * CheckboxGroup component for Akinon UI.
+ *
+ * This component provides a way to manage multiple checkboxes as a group,
+ * allowing for easier handling of values, validation, and styling. It supports
+ * both controlled and uncontrolled states, as well as customization options for
+ * individual checkboxes.
+ *
+ * The CheckboxGroup component adheres to the Akinon design system, ensuring
+ * consistency and accessibility across all use cases. It simplifies scenarios
+ * where multiple related options need to be selected by maintaining a unified
+ * state for the group.
+ */
 export declare const CheckboxGroup: React.FC<CheckboxGroupProps>;
 export type * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAOA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEjE,eAAO,MAAM,QAAQ,uCAAwC,aAAa,sBAgCzE,CAAC;AAEF,eAAO,MAAM,aAAa,EAAwB,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAE/E,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAOA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEjE;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,QAAQ,uCAAwC,aAAa,sBAgCzE,CAAC;AAEF;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,aAAa,EAAwB,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAE/E,mBAAmB,SAAS,CAAC"}

package/dist/cjs/index.js

@@ -16,6 +16,18 @@ const ui_theme_1 = require("@akinon/ui-theme");
 const cssinjs_1 = require("@ant-design/cssinjs");
 const antd_1 = require("antd");
 const React = require("react");
+/**
+ * Checkbox component for Akinon UI.
+ *
+ * This component provides a versatile checkbox implementation, supporting both standalone usage
+ * and grouped configurations (via CheckboxGroup). It offers flexibility with various states,
+ * event handlers, and accessibility features.
+ *
+ * The Checkbox component adheres to the Akinon design system, ensuring consistent behavior
+ * and appearance. Custom styles are not permitted to maintain design integrity.
+ *
+ * For group usage, refer to the CheckboxGroup, which manages multiple checkboxes and their states.
+ */
 const Checkbox = (_a) => {
     var { children } = _a, restCheckboxProps = __rest(_a, ["children"]);
     const { getPrefixCls, theme } = React.useContext(antd_1.ConfigProvider.ConfigContext);
@@ -38,4 +50,17 @@ const Checkbox = (_a) => {
     return useStyle(React.createElement(antd_1.Checkbox, Object.assign({}, restCheckboxProps), children));
 };
 exports.Checkbox = Checkbox;
+/**
+ * CheckboxGroup component for Akinon UI.
+ *
+ * This component provides a way to manage multiple checkboxes as a group,
+ * allowing for easier handling of values, validation, and styling. It supports
+ * both controlled and uncontrolled states, as well as customization options for
+ * individual checkboxes.
+ *
+ * The CheckboxGroup component adheres to the Akinon design system, ensuring
+ * consistency and accessibility across all use cases. It simplifies scenarios
+ * where multiple related options need to be selected by maintaining a unified
+ * state for the group.
+ */
 exports.CheckboxGroup = antd_1.Checkbox.Group;

package/dist/cjs/types.d.ts

@@ -3,27 +3,112 @@ import { type DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE } from '@akinon/ui-
 export type CheckboxValueType = string | number | boolean;
 
 export interface CheckboxProps {
+  /**
+   * Additional CSS class for the Checkbox.
+   */
   className?: string;
+
+  /**
+   * Whether the checkbox is initially checked.
+   */
   defaultChecked?: boolean;
+
+  /**
+   * The controlled checked state of the checkbox.
+   */
   checked?: boolean;
+
+  /**
+   * Whether the checkbox is disabled.
+   */
   disabled?: boolean;
+
+  /**
+   * A descriptive title for the checkbox, used for accessibility.
+   */
   title?: string;
+
+  /**
+   * Event handler triggered when the checkbox value changes.
+   * @param e - The change event object.
+   */
   onChange?: (e: CheckboxChangeEvent) => void;
+
+  /**
+   * Event handler triggered when the checkbox is clicked.
+   */
   onClick?: React.MouseEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when the mouse enters the checkbox.
+   */
   onMouseEnter?: React.MouseEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when the mouse leaves the checkbox.
+   */
   onMouseLeave?: React.MouseEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when a key is pressed while the checkbox is focused.
+   */
   onKeyPress?: React.KeyboardEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when a key is pressed down while the checkbox is focused.
+   */
   onKeyDown?: React.KeyboardEventHandler<HTMLElement>;
+
+  /**
+   * The value associated with the checkbox.
+   */
   value?: CheckboxValueType;
+
+  /**
+   * The tab index of the checkbox.
+   */
   tabIndex?: number;
+
+  /**
+   * The name attribute for the checkbox.
+   */
   name?: string;
+
+  /**
+   * The content displayed next to the checkbox.
+   */
   children?: React.ReactNode;
+
+  /**
+   * The unique identifier for the checkbox.
+   */
   id?: string;
+
+  /**
+   * Whether the checkbox should automatically gain focus on render.
+   */
   autoFocus?: boolean;
+
+  /**
+   * The input type of the checkbox. Defaults to 'checkbox'.
+   */
   type?: string;
+
+  /**
+   * If true, skips group handling when used inside a CheckboxGroup.
+   */
   skipGroup?: boolean;
+
+  /**
+   * Whether the checkbox is required for form submission.
+   */
   required?: boolean;
+
+  /**
+   * Whether the checkbox is in an indeterminate state (partially selected).
+   */
   indeterminate?: boolean;
+
   /**
    * Never use this prop. Akinon design system does not allow custom styles.
    * @ignore
@@ -32,37 +117,117 @@ export interface CheckboxProps {
 }
 
 export interface CheckboxChangeEventTarget extends CheckboxProps {
+  /**
+   * Indicates whether the checkbox is checked.
+   */
   checked: boolean;
 }
 
 export interface CheckboxChangeEvent {
+  /**
+   * The target checkbox that triggered the event.
+   */
   target: CheckboxChangeEventTarget;
+
+  /**
+   * Stops event propagation.
+   */
   stopPropagation: () => void;
+
+  /**
+   * Prevents the default behavior of the event.
+   */
   preventDefault: () => void;
+
+  /**
+   * The native mouse event.
+   */
   nativeEvent: MouseEvent;
 }
 
 export interface CheckboxOptionType<
   T extends CheckboxValueType = CheckboxValueType
 > {
+  /**
+   * The label displayed next to the checkbox. Can be a string or a React node.
+   */
   label: React.ReactNode;
+
+  /**
+   * The value associated with the checkbox. Must match the generic type `T`.
+   */
   value: T;
+
+  /**
+   * Whether the checkbox option is disabled.
+   * @default false
+   */
   disabled?: boolean;
+
+  /**
+   * A descriptive title for the checkbox option, used for accessibility.
+   */
   title?: string;
+
+  /**
+   * The unique identifier for the checkbox option.
+   */
   id?: string;
+
+  /**
+   * Event handler triggered when the option's value changes.
+   * @param e - The change event object.
+   */
   onChange?: (e: CheckboxChangeEvent) => void;
+
+  /**
+   * Whether the checkbox option is required for form submission.
+   * @default false
+   */
   required?: boolean;
 }
 
 export interface CheckboxGroupProps<
   T extends CheckboxValueType = CheckboxValueType
 > {
+  /**
+   * Additional CSS class for the CheckboxGroup.
+   */
   className?: string;
+
+  /**
+   * The options for the checkbox group. Each option can be a string, number, or an object.
+   */
   options?: (CheckboxOptionType<T> | string | number)[];
+
+  /**
+   * Whether the entire group is disabled.
+   */
   disabled?: boolean;
+
+  /**
+   * The name attribute for all checkboxes in the group.
+   */
   name?: string;
+
+  /**
+   * The default checked values of the group.
+   */
   defaultValue?: T[];
+
+  /**
+   * The controlled checked values of the group.
+   */
   value?: T[];
+
+  /**
+   * Event handler triggered when the group value changes.
+   * @param checkedValue - An array of checked values.
+   */
   onChange?: (checkedValue: T[]) => void;
+
+  /**
+   * The content displayed within the CheckboxGroup.
+   */
   children?: React.ReactNode;
 }

package/dist/esm/index.d.ts

@@ -1,6 +1,31 @@
 import * as React from 'react';
 import type { CheckboxGroupProps, CheckboxProps } from './types';
+/**
+ * Checkbox component for Akinon UI.
+ *
+ * This component provides a versatile checkbox implementation, supporting both standalone usage
+ * and grouped configurations (via CheckboxGroup). It offers flexibility with various states,
+ * event handlers, and accessibility features.
+ *
+ * The Checkbox component adheres to the Akinon design system, ensuring consistent behavior
+ * and appearance. Custom styles are not permitted to maintain design integrity.
+ *
+ * For group usage, refer to the CheckboxGroup, which manages multiple checkboxes and their states.
+ */
 export declare const Checkbox: ({ children, ...restCheckboxProps }: CheckboxProps) => React.JSX.Element;
+/**
+ * CheckboxGroup component for Akinon UI.
+ *
+ * This component provides a way to manage multiple checkboxes as a group,
+ * allowing for easier handling of values, validation, and styling. It supports
+ * both controlled and uncontrolled states, as well as customization options for
+ * individual checkboxes.
+ *
+ * The CheckboxGroup component adheres to the Akinon design system, ensuring
+ * consistency and accessibility across all use cases. It simplifies scenarios
+ * where multiple related options need to be selected by maintaining a unified
+ * state for the group.
+ */
 export declare const CheckboxGroup: React.FC<CheckboxGroupProps>;
 export type * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAOA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEjE,eAAO,MAAM,QAAQ,uCAAwC,aAAa,sBAgCzE,CAAC;AAEF,eAAO,MAAM,aAAa,EAAwB,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAE/E,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAOA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEjE;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,QAAQ,uCAAwC,aAAa,sBAgCzE,CAAC;AAEF;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,aAAa,EAAwB,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAE/E,mBAAmB,SAAS,CAAC"}

package/dist/esm/index.js

@@ -13,6 +13,18 @@ import { useToken } from '@akinon/ui-theme';
 import { useStyleRegister } from '@ant-design/cssinjs';
 import { Checkbox as AntCheckbox, ConfigProvider } from 'antd';
 import * as React from 'react';
+/**
+ * Checkbox component for Akinon UI.
+ *
+ * This component provides a versatile checkbox implementation, supporting both standalone usage
+ * and grouped configurations (via CheckboxGroup). It offers flexibility with various states,
+ * event handlers, and accessibility features.
+ *
+ * The Checkbox component adheres to the Akinon design system, ensuring consistent behavior
+ * and appearance. Custom styles are not permitted to maintain design integrity.
+ *
+ * For group usage, refer to the CheckboxGroup, which manages multiple checkboxes and their states.
+ */
 export const Checkbox = (_a) => {
     var { children } = _a, restCheckboxProps = __rest(_a, ["children"]);
     const { getPrefixCls, theme } = React.useContext(ConfigProvider.ConfigContext);
@@ -34,4 +46,17 @@ export const Checkbox = (_a) => {
     });
     return useStyle(React.createElement(AntCheckbox, Object.assign({}, restCheckboxProps), children));
 };
+/**
+ * CheckboxGroup component for Akinon UI.
+ *
+ * This component provides a way to manage multiple checkboxes as a group,
+ * allowing for easier handling of values, validation, and styling. It supports
+ * both controlled and uncontrolled states, as well as customization options for
+ * individual checkboxes.
+ *
+ * The CheckboxGroup component adheres to the Akinon design system, ensuring
+ * consistency and accessibility across all use cases. It simplifies scenarios
+ * where multiple related options need to be selected by maintaining a unified
+ * state for the group.
+ */
 export const CheckboxGroup = AntCheckbox.Group;

package/dist/esm/types.d.ts

@@ -3,27 +3,112 @@ import { type DO_NOT_USE_OR_YOU_WILL_BE_FIRED_INTERNAL_STYLE } from '@akinon/ui-
 export type CheckboxValueType = string | number | boolean;
 
 export interface CheckboxProps {
+  /**
+   * Additional CSS class for the Checkbox.
+   */
   className?: string;
+
+  /**
+   * Whether the checkbox is initially checked.
+   */
   defaultChecked?: boolean;
+
+  /**
+   * The controlled checked state of the checkbox.
+   */
   checked?: boolean;
+
+  /**
+   * Whether the checkbox is disabled.
+   */
   disabled?: boolean;
+
+  /**
+   * A descriptive title for the checkbox, used for accessibility.
+   */
   title?: string;
+
+  /**
+   * Event handler triggered when the checkbox value changes.
+   * @param e - The change event object.
+   */
   onChange?: (e: CheckboxChangeEvent) => void;
+
+  /**
+   * Event handler triggered when the checkbox is clicked.
+   */
   onClick?: React.MouseEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when the mouse enters the checkbox.
+   */
   onMouseEnter?: React.MouseEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when the mouse leaves the checkbox.
+   */
   onMouseLeave?: React.MouseEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when a key is pressed while the checkbox is focused.
+   */
   onKeyPress?: React.KeyboardEventHandler<HTMLElement>;
+
+  /**
+   * Event handler triggered when a key is pressed down while the checkbox is focused.
+   */
   onKeyDown?: React.KeyboardEventHandler<HTMLElement>;
+
+  /**
+   * The value associated with the checkbox.
+   */
   value?: CheckboxValueType;
+
+  /**
+   * The tab index of the checkbox.
+   */
   tabIndex?: number;
+
+  /**
+   * The name attribute for the checkbox.
+   */
   name?: string;
+
+  /**
+   * The content displayed next to the checkbox.
+   */
   children?: React.ReactNode;
+
+  /**
+   * The unique identifier for the checkbox.
+   */
   id?: string;
+
+  /**
+   * Whether the checkbox should automatically gain focus on render.
+   */
   autoFocus?: boolean;
+
+  /**
+   * The input type of the checkbox. Defaults to 'checkbox'.
+   */
   type?: string;
+
+  /**
+   * If true, skips group handling when used inside a CheckboxGroup.
+   */
   skipGroup?: boolean;
+
+  /**
+   * Whether the checkbox is required for form submission.
+   */
   required?: boolean;
+
+  /**
+   * Whether the checkbox is in an indeterminate state (partially selected).
+   */
   indeterminate?: boolean;
+
   /**
    * Never use this prop. Akinon design system does not allow custom styles.
    * @ignore
@@ -32,37 +117,117 @@ export interface CheckboxProps {
 }
 
 export interface CheckboxChangeEventTarget extends CheckboxProps {
+  /**
+   * Indicates whether the checkbox is checked.
+   */
   checked: boolean;
 }
 
 export interface CheckboxChangeEvent {
+  /**
+   * The target checkbox that triggered the event.
+   */
   target: CheckboxChangeEventTarget;
+
+  /**
+   * Stops event propagation.
+   */
   stopPropagation: () => void;
+
+  /**
+   * Prevents the default behavior of the event.
+   */
   preventDefault: () => void;
+
+  /**
+   * The native mouse event.
+   */
   nativeEvent: MouseEvent;
 }
 
 export interface CheckboxOptionType<
   T extends CheckboxValueType = CheckboxValueType
 > {
+  /**
+   * The label displayed next to the checkbox. Can be a string or a React node.
+   */
   label: React.ReactNode;
+
+  /**
+   * The value associated with the checkbox. Must match the generic type `T`.
+   */
   value: T;
+
+  /**
+   * Whether the checkbox option is disabled.
+   * @default false
+   */
   disabled?: boolean;
+
+  /**
+   * A descriptive title for the checkbox option, used for accessibility.
+   */
   title?: string;
+
+  /**
+   * The unique identifier for the checkbox option.
+   */
   id?: string;
+
+  /**
+   * Event handler triggered when the option's value changes.
+   * @param e - The change event object.
+   */
   onChange?: (e: CheckboxChangeEvent) => void;
+
+  /**
+   * Whether the checkbox option is required for form submission.
+   * @default false
+   */
   required?: boolean;
 }
 
 export interface CheckboxGroupProps<
   T extends CheckboxValueType = CheckboxValueType
 > {
+  /**
+   * Additional CSS class for the CheckboxGroup.
+   */
   className?: string;
+
+  /**
+   * The options for the checkbox group. Each option can be a string, number, or an object.
+   */
   options?: (CheckboxOptionType<T> | string | number)[];
+
+  /**
+   * Whether the entire group is disabled.
+   */
   disabled?: boolean;
+
+  /**
+   * The name attribute for all checkboxes in the group.
+   */
   name?: string;
+
+  /**
+   * The default checked values of the group.
+   */
   defaultValue?: T[];
+
+  /**
+   * The controlled checked values of the group.
+   */
   value?: T[];
+
+  /**
+   * Event handler triggered when the group value changes.
+   * @param checkedValue - An array of checked values.
+   */
   onChange?: (checkedValue: T[]) => void;
+
+  /**
+   * The content displayed within the CheckboxGroup.
+   */
   children?: React.ReactNode;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/ui-checkbox",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "private": false,
   "type": "module",
   "main": "dist/esm/index.js",
@@ -9,15 +9,15 @@
     "dist"
   ],
   "dependencies": {
-    "antd": "5.17.0",
-    "@akinon/ui-theme": "0.7.0"
+    "antd": "5.22.6",
+    "@akinon/ui-theme": "1.0.0"
   },
   "devDependencies": {
     "clean-package": "2.2.0",
     "copyfiles": "^2.4.1",
     "rimraf": "^5.0.5",
-    "typescript": "^5.2.2",
-    "@akinon/typescript-config": "0.4.0"
+    "typescript": "*",
+    "@akinon/typescript-config": "1.0.0"
   },
   "peerDependencies": {
     "react": ">=18",