@destyler/checkbox 0.2.6 → 0.2.7

package/dist/index.d.mts

@@ -1,10 +1,9 @@
-import * as _destyler_anatomy0 from "@destyler/anatomy";
 import * as _destyler_xstate0 from "@destyler/xstate";
 import { AnyEventObject, Machine, XSend, XState } from "@destyler/xstate";
 import { CommonProperties, DirectionProperty, NormalizeProps, PropTypes, RequiredBy } from "@destyler/types";
 
 //#region src/anatomy.d.ts
-declare const anatomy: _destyler_anatomy0.AnatomyInstance<"root" | "control" | "label" | "indicator">;
+declare const anatomy: any;
 //#endregion
 //#region src/types.d.ts
 type CheckedState = boolean | 'indeterminate';
@@ -35,9 +34,14 @@ interface PublicContext extends DirectionProperty, CommonProperties {
    */
   required?: boolean | undefined;
   /**
-   * The checked state of the checkbox
+   * The controlled checked state of the checkbox
    */
-  checked: CheckedState;
+  checked?: CheckedState | undefined;
+  /**
+   * The initial checked state of the checkbox when it is not controlled.
+   * Prefer this over seeding with `checked` for uncontrolled usage.
+   */
+  defaultChecked?: CheckedState | undefined;
   /**
    * Whether the checkbox is read-only
    */
@@ -153,7 +157,7 @@ declare function connect<T extends PropTypes>(state: State, send: Send, normaliz
 declare function machine(userContext: UserDefinedContext): _destyler_xstate0.Machine<MachineContext, MachineState, _destyler_xstate0.AnyEventObject>;
 //#endregion
 //#region src/props.d.ts
-declare const props: ("value" | "ids" | "disabled" | "invalid" | "required" | "checked" | "readOnly" | "onCheckedChange" | "name" | "form" | "dir" | "id" | "getRootNode")[];
-declare const splitProps: <Props extends Partial<UserDefinedContext>>(props: Props) => [Partial<UserDefinedContext>, Omit<Props, "value" | "ids" | "disabled" | "invalid" | "required" | "checked" | "readOnly" | "onCheckedChange" | "name" | "form" | "dir" | "id" | "getRootNode">];
+declare const props: ("value" | "ids" | "disabled" | "invalid" | "required" | "checked" | "defaultChecked" | "readOnly" | "onCheckedChange" | "name" | "form" | "dir" | "id" | "getRootNode")[];
+declare const splitProps: <Props extends Partial<UserDefinedContext>>(props: Props) => [Partial<UserDefinedContext>, Omit<Props, "value" | "ids" | "disabled" | "invalid" | "required" | "checked" | "defaultChecked" | "readOnly" | "onCheckedChange" | "name" | "form" | "dir" | "id" | "getRootNode">];
 //#endregion
 export { type MachineApi as Api, type CheckedChangeDetails, type CheckedState, type UserDefinedContext as Context, type ElementIds, type MachineState, type Service, type State, anatomy, connect, machine, props, splitProps };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { createAnatomy } from "@destyler/anatomy";
 import { createScope, dataAttr, dispatchInputCheckedEvent, getEventTarget, setElementChecked, trackFormControl, trackPress, visuallyHiddenStyle } from "@destyler/dom";
 import { isFocusVisible, trackFocusVisible } from "@destyler/focus-visible";
-import { compact, createSplitProps, isEqual } from "@destyler/utils";
+import { compact, createSplitProps, isControlled, isEqual, isPropUserProvided, resolveControllableProp, withControllableProvided } from "@destyler/utils";
 import { createMachine, guards } from "@destyler/xstate";
 import { createProps } from "@destyler/types";
 
@@ -167,23 +167,34 @@ function isIndeterminate(checked) {
 function isChecked(checked) {
 	return isIndeterminate(checked) ? false : !!checked;
 }
-const invoke = { change: (ctx) => {
-	ctx.onCheckedChange?.({ checked: ctx.checked });
+const invoke = { change: (ctx, checked) => {
+	ctx.onCheckedChange?.({ checked });
 } };
 const set = { checked: (ctx, checked) => {
 	if (isEqual(ctx.checked, checked)) return;
+	if (isControlled(ctx, "checked")) {
+		invoke.change(ctx, checked);
+		return;
+	}
 	ctx.checked = checked;
-	invoke.change(ctx);
+	invoke.change(ctx, checked);
 } };
 function machine(userContext) {
+	const ctx = compact(withControllableProvided(userContext, ["checked"]));
+	const { initial: initialChecked } = resolveControllableProp({
+		value: ctx.checked,
+		defaultValue: ctx.defaultChecked,
+		valueProvided: isPropUserProvided(ctx, "checked"),
+		fallback: false
+	});
 	return createMachine({
 		id: "checkbox",
 		initial: "ready",
 		context: {
-			checked: false,
 			value: "on",
 			disabled: false,
-			...compact(userContext),
+			...ctx,
+			checked: initialChecked,
 			fieldsetDisabled: false,
 			focusVisible: false
 		},
@@ -208,33 +219,33 @@ function machine(userContext) {
 			"CONTEXT.SET": { actions: ["setContext"] }
 		},
 		computed: {
-			isIndeterminate: (ctx) => isIndeterminate(ctx.checked),
-			isChecked: (ctx) => isChecked(ctx.checked),
-			isDisabled: (ctx) => !!ctx.disabled || ctx.fieldsetDisabled
+			isIndeterminate: (ctx$1) => isIndeterminate(ctx$1.checked),
+			isChecked: (ctx$1) => isChecked(ctx$1.checked),
+			isDisabled: (ctx$1) => !!ctx$1.disabled || ctx$1.fieldsetDisabled
 		},
 		states: { ready: {} }
 	}, {
 		guards: { isTrusted: (_ctx, evt) => !!evt.isTrusted },
 		activities: {
-			trackPressEvent(ctx) {
-				if (ctx.isDisabled) return;
+			trackPressEvent(ctx$1) {
+				if (ctx$1.isDisabled) return;
 				return trackPress({
-					pointerNode: dom.getRootEl(ctx),
-					keyboardNode: dom.getHiddenInputEl(ctx),
+					pointerNode: dom.getRootEl(ctx$1),
+					keyboardNode: dom.getHiddenInputEl(ctx$1),
 					isValidKey: (event) => event.key === " ",
-					onPress: () => ctx.active = false,
-					onPressStart: () => ctx.active = true,
-					onPressEnd: () => ctx.active = false
+					onPress: () => ctx$1.active = false,
+					onPressStart: () => ctx$1.active = true,
+					onPressEnd: () => ctx$1.active = false
 				});
 			},
-			trackFocusVisible(ctx) {
-				if (ctx.isDisabled) return;
-				return trackFocusVisible({ root: dom.getRootNode(ctx) });
+			trackFocusVisible(ctx$1) {
+				if (ctx$1.isDisabled) return;
+				return trackFocusVisible({ root: dom.getRootNode(ctx$1) });
 			},
-			trackFormControlState(ctx, _evt, { send, initialContext }) {
-				return trackFormControl(dom.getHiddenInputEl(ctx), {
+			trackFormControlState(ctx$1, _evt, { send, initialContext }) {
+				return trackFormControl(dom.getHiddenInputEl(ctx$1), {
 					onFieldsetDisabledChange(disabled) {
-						ctx.fieldsetDisabled = disabled;
+						ctx$1.fieldsetDisabled = disabled;
 					},
 					onFormReset() {
 						send({
@@ -246,30 +257,30 @@ function machine(userContext) {
 			}
 		},
 		actions: {
-			setContext(ctx, evt) {
-				Object.assign(ctx, evt.context);
+			setContext(ctx$1, evt) {
+				Object.assign(ctx$1, evt.context);
 			},
-			syncInputElement(ctx) {
-				const inputEl = dom.getHiddenInputEl(ctx);
+			syncInputElement(ctx$1) {
+				const inputEl = dom.getHiddenInputEl(ctx$1);
 				if (!inputEl) return;
-				setElementChecked(inputEl, ctx.isChecked);
-				inputEl.indeterminate = ctx.isIndeterminate;
+				setElementChecked(inputEl, ctx$1.isChecked);
+				inputEl.indeterminate = ctx$1.isIndeterminate;
 			},
-			removeFocusIfNeeded(ctx) {
-				if (ctx.disabled && ctx.focused) {
-					ctx.focused = false;
-					ctx.focusVisible = false;
+			removeFocusIfNeeded(ctx$1) {
+				if (ctx$1.disabled && ctx$1.focused) {
+					ctx$1.focused = false;
+					ctx$1.focusVisible = false;
 				}
 			},
-			setChecked(ctx, evt) {
-				set.checked(ctx, evt.checked);
+			setChecked(ctx$1, evt) {
+				set.checked(ctx$1, evt.checked);
 			},
-			toggleChecked(ctx) {
-				const checked = isIndeterminate(ctx.checked) ? true : !ctx.checked;
-				set.checked(ctx, checked);
+			toggleChecked(ctx$1) {
+				const checked = isIndeterminate(ctx$1.checked) ? true : !ctx$1.checked;
+				set.checked(ctx$1, checked);
 			},
-			dispatchChangeEvent(ctx) {
-				dispatchInputCheckedEvent(dom.getHiddenInputEl(ctx), { checked: isChecked(ctx.checked) });
+			dispatchChangeEvent(ctx$1) {
+				dispatchInputCheckedEvent(dom.getHiddenInputEl(ctx$1), { checked: isChecked(ctx$1.checked) });
 			}
 		}
 	});
@@ -279,6 +290,7 @@ function machine(userContext) {
 //#region src/props.ts
 const props = createProps()([
 	"checked",
+	"defaultChecked",
 	"dir",
 	"disabled",
 	"form",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@destyler/checkbox",
   "type": "module",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "a control that allows the user to toggle between checked and not checked.",
   "author": "Elone Hoo <elonehoo@gmail.com>",
   "license": "MIT",
@@ -22,12 +22,12 @@
     "dist"
   ],
   "dependencies": {
-    "@destyler/anatomy": "0.2.6",
-    "@destyler/focus-visible": "0.2.6",
-    "@destyler/dom": "0.2.6",
-    "@destyler/types": "0.2.6",
-    "@destyler/xstate": "0.2.6",
-    "@destyler/utils": "0.2.6"
+    "@destyler/anatomy": "0.2.7",
+    "@destyler/dom": "0.2.7",
+    "@destyler/focus-visible": "0.2.7",
+    "@destyler/types": "0.2.7",
+    "@destyler/xstate": "0.2.7",
+    "@destyler/utils": "0.2.7"
   },
   "publishConfig": {
     "access": "public"