@muraldevkit/ui-toolkit 1.20.1 → 1.21.1

package/dist/components/form/checkbox/MrlCheckbox/MrlCheckbox.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="react" />
+import { AttrsObject } from '../../../../utils';
+import { CheckboxSelected, CheckboxStates, StaticIconConfig } from '../../constants';
+import './MrlCheckbox.global.scss';
+interface MrlCheckboxProps {
+    /** Applies additional HTML attributes to the checkbox element */
+    attrs?: AttrsObject;
+    /** Additional class to add to the container of the checkbox and label */
+    className?: string;
+    /** The current state of the checkbox input based on user interactions or permissions */
+    state?: CheckboxStates;
+    /**
+     * Sets what selection state the checkbox is in.
+     *
+     * @todo implement 'indeterminate'
+     */
+    selected?: CheckboxSelected;
+    /** The text to display as the checkbox's label */
+    label: string;
+    /** Leading label icon */
+    icon?: StaticIconConfig;
+}
+/**
+ * Form element with an associated text label that allows the user to select one or more options
+ * from a provided list
+ *
+ * @param {MrlCheckboxProps} props - the component props
+ * @returns a checkbox element with an associated label
+ */
+export declare function MrlCheckbox({ attrs, className, state, selected, icon, label }: MrlCheckboxProps): JSX.Element;
+export {};

package/dist/components/form/checkbox/MrlCheckbox/index.d.ts

@@ -0,0 +1 @@
+export * from './MrlCheckbox';

package/dist/components/form/checkbox/MrlCheckboxStandalone/MrlCheckboxStandalone.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import { AttrsObject } from '../../../../utils';
+import { CheckboxSelected, CheckboxStates } from '../../constants';
+import './MrlCheckboxStandalone.global.scss';
+interface MrlCheckboxStandaloneProps {
+    /** Applies additional HTML attributes to the checkbox element */
+    attrs?: AttrsObject;
+    /** The current state of the checkbox input based on user interactions or permissions */
+    state?: CheckboxStates;
+    /**
+     * Sets what selection state the checkbox is in.
+     *
+     * @todo implement 'indeterminate'
+     */
+    selected?: CheckboxSelected;
+}
+/**
+ * Input that allows the user to select one or more options from a provided list.
+ * Note, this component does not provide out of the box accessibility for ensuring
+ * an associated label and must be manually setup during adoption.
+ *
+ * @param {MrlCheckboxStandaloneProps} props - the component props
+ * @returns a checkbox element
+ */
+export declare function MrlCheckboxStandalone({ attrs, state, selected }: MrlCheckboxStandaloneProps): JSX.Element;
+export {};

package/dist/components/form/checkbox/MrlCheckboxStandalone/index.d.ts

@@ -0,0 +1 @@
+export * from './MrlCheckboxStandalone';

package/dist/components/form/index.d.ts

@@ -5,3 +5,5 @@ export * from './text-input/MrlTextInput';
 export * from './label/MrlLabel';
 export * from './textarea/MrlTextarea';
 export * from './fieldset/MrlFieldset';
+export * from './checkbox/MrlCheckbox';
+export * from './checkbox/MrlCheckboxStandalone';