@useloops/design-system 1.4.149 → 1.4.150

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import { MuiMarkdownProps } from 'mui-markdown';
 import { NumericFormatProps } from 'react-number-format';
 import { UniqueIdentifier } from '@dnd-kit/core';
 import { SubmitHandler } from 'react-hook-form';
+import { TextFieldProps as TextFieldProps$2, NumberFieldProps as NumberFieldProps$1, TextareaProps as TextareaProps$1, SelectProps as SelectProps$2, CheckboxProps as CheckboxProps$2, CheckboxGroupProps as CheckboxGroupProps$1, SwitchProps as SwitchProps$2, SliderProps as SliderProps$1, DifferentialProps as DifferentialProps$1, LikertProps as LikertProps$1, RadioGroupProps as RadioGroupProps$1, RankProps as RankProps$1, RichTextFieldProps as RichTextFieldProps$1, StarRatingProps as StarRatingProps$1, HtmlProps as HtmlProps$1, CustomFieldProps as CustomFieldProps$1, InputLabelProps as InputLabelProps$1, InputLabelHelpProps as InputLabelHelpProps$1 } from 'WebCore';
 
 interface ColorRange {
     0: string;
@@ -326,6 +327,7 @@ interface FormControlLabelProps {
     checked?: boolean;
     disabled?: boolean;
     label?: string | ReactElement;
+    labelPlacement?: FormControlLabelProps$1['labelPlacement'];
     sx?: SxProps<Theme>;
     onChange?: FormControlLabelProps$1['onChange'];
     value?: unknown;
@@ -691,9 +693,18 @@ interface SurfaceProps extends PropsWithChildren {
 }
 declare const Surface: FC<SurfaceProps>;
 
-interface SwitchProps extends SwitchProps$1 {
+interface StyledSwitchProps extends SwitchProps$1 {
 }
-declare const Switch: _emotion_styled.StyledComponent<SwitchProps & _mui_system.MUIStyledCommonProps<_mui_material.Theme>, {}, {}>;
+
+interface SwitchProps extends StyledSwitchProps {
+    value?: boolean;
+    label?: string | ReactElement;
+    labelPlacement?: Exclude<FormControlLabelProps['labelPlacement'], 'top' | 'bottom'>;
+    fullWidth?: boolean;
+    onChange?: (event: React.SyntheticEvent<Element, Event>, checked: boolean) => void;
+    internalChange?: () => void;
+}
+declare const Switch: FunctionComponent<SwitchProps>;
 
 type TextareaProps = InputFieldBaseProps & {
     startAdornment?: ReactElement;
@@ -756,6 +767,9 @@ interface BackgroundOptions {
 }
 declare const backgroundCreator: (theme: Theme, options: BackgroundOptions) => string;
 
+/**
+ * Form Generator Core Types
+ */
 interface FormGeneratorHandler {
     set: () => void;
     reset: () => void;
@@ -766,12 +780,12 @@ interface FormGeneratorHandler {
     triggerFormValidation: () => Promise<unknown>;
 }
 type FormGeneratorProps = FunctionComponent<{
+    ref?: any;
     formConfig: FormGeneratorConfig;
     onFormSubmit?: SubmitHandler<any>;
     onFormChange?: (formData: any) => void;
     submitButton?: ReactElement;
     secondaryButton?: ReactElement;
-    ref?: any;
 }>;
 interface FormGeneratorConfig {
     fields: FieldTypes[];
@@ -785,78 +799,47 @@ interface FormGeneratorConfig {
         sxStack?: SxProps<Theme>;
     };
 }
-type TextFieldType = {
-    fieldType: 'textfield';
-} & BaseField & Omit<TextFieldProps, 'value' | 'onChange' | 'name'>;
-type NumberFieldType = {
-    fieldType: 'numberfield';
-} & BaseField & Omit<NumberFieldProps, 'value' | 'onChange' | 'name'>;
-type TextareaType = {
-    fieldType: 'textarea';
-} & BaseField & Omit<TextareaProps, 'value' | 'onChange' | 'name'>;
-type SelectType = {
-    fieldType: 'select';
-    defaultValue?: SelectProps['value'];
-} & BaseField & Omit<SelectProps, 'value' | 'onChange' | 'name'>;
-type CheckboxType = {
-    fieldType: 'checkbox';
-    defaultValue?: CheckboxProps['value'];
-} & BaseField & Omit<CheckboxProps, 'value' | 'onChange' | 'name'>;
-type CheckboxGroupType = {
-    fieldType: 'checkboxGroup';
-    defaultValue?: string[];
-} & BaseField & Omit<CheckboxGroupProps, 'value' | 'onChange' | 'name'>;
-type SliderType = {
-    fieldType: 'slider';
-    defaultValue?: SliderProps['value'];
-} & BaseField & Omit<SliderProps, 'value' | 'onChange' | 'name'>;
-type DifferentialType = {
-    fieldType: 'differential';
-    defaultValue?: DifferentialProps['value'];
-} & BaseField & Omit<DifferentialProps, 'value' | 'onChange' | 'name'>;
-type LikertType = {
-    fieldType: 'likert';
-    defaultValue?: LikertProps['value'];
-} & BaseField & Omit<LikertProps, 'value' | 'onChange' | 'name'>;
-type RadioGroupType = {
-    fieldType: 'radioGroup';
-    defaultValue?: RadioGroupProps['value'];
-} & BaseField & Omit<RadioGroupProps, 'value' | 'onChange' | 'name'>;
-type DragAndDropRankingType = {
-    fieldType: 'ranking';
-    defaultValue?: RankProps['value'];
-} & BaseField & Omit<RankProps, 'value' | 'onChange' | 'name'>;
-type RichTextFieldType = {
-    fieldType: 'richTextfield';
-    defaultValue?: RichTextFieldProps['value'];
-} & BaseField & Omit<RichTextFieldProps, 'value' | 'onChange' | 'name'>;
-type StarRatingType = {
-    fieldType: 'starRating';
-    defaultValue?: StarRatingProps['value'];
-} & BaseField & Omit<StarRatingProps, 'value' | 'onChange' | 'name'>;
+/**
+ * Field Types
+ */
+type FieldTypes = CheckboxType | CheckboxGroupType | SwitchType | TextareaType | SelectType | TextFieldType | SliderType | DifferentialType | RichTextFieldType | LikertType | RadioGroupType | DragAndDropRankingType | NumberFieldType | StarRatingType | HTMLType | CustomFieldType;
+type TextFieldType = CreateFieldType<'textfield', TextFieldProps$2, string>;
+type NumberFieldType = CreateFieldType<'numberfield', NumberFieldProps$1, number>;
+type TextareaType = CreateFieldType<'textarea', TextareaProps$1, string>;
+type SelectType = CreateFieldType<'select', SelectProps$2, SelectProps$2['value']>;
+type CheckboxType = CreateFieldType<'checkbox', CheckboxProps$2, NonNullable<CheckboxProps$2['value']>>;
+type CheckboxGroupType = CreateFieldType<'checkboxGroup', CheckboxGroupProps$1, string[]>;
+type SwitchType = CreateFieldType<'switch', SwitchProps$2, NonNullable<SwitchProps$2['checked']>>;
+type SliderType = CreateFieldType<'slider', SliderProps$1, NonNullable<SliderProps$1['value']>>;
+type DifferentialType = CreateFieldType<'differential', DifferentialProps$1, NonNullable<DifferentialProps$1['value']>>;
+type LikertType = CreateFieldType<'likert', LikertProps$1, LikertProps$1['value']>;
+type RadioGroupType = CreateFieldType<'radioGroup', RadioGroupProps$1, RadioGroupProps$1['value']>;
+type DragAndDropRankingType = CreateFieldType<'ranking', RankProps$1, NonNullable<RankProps$1['value']>>;
+type RichTextFieldType = CreateFieldType<'richTextfield', RichTextFieldProps$1, RichTextFieldProps$1['value']>;
+type StarRatingType = CreateFieldType<'starRating', StarRatingProps$1, NonNullable<StarRatingProps$1['value']>>;
 type HTMLType = {
     fieldType: 'html';
-    content: HtmlProps['children'];
+    content: HtmlProps$1['children'];
     defaultValue?: never;
 } & BaseField;
 type CustomFieldType = {
     fieldType: 'customfield';
-    defaultValue?: CustomFieldProps['value'];
-} & BaseField & CustomFieldProps;
-type DynamicFieldType = 'textfield' | 'numberfield' | 'textarea' | 'select' | 'checkbox' | 'checkboxGroup' | 'slider' | 'differential' | 'likert' | 'starRating' | 'radioGroup' | 'ranking' | 'richTextfield' | 'customfield';
-type FieldType = DynamicFieldType | 'html';
-type FieldTypes = CheckboxType | CheckboxGroupType | TextareaType | SelectType | TextFieldType | SliderType | DifferentialType | RichTextFieldType | LikertType | RadioGroupType | DragAndDropRankingType | NumberFieldType | StarRatingType | HTMLType | CustomFieldType;
+    defaultValue?: CustomFieldProps$1['value'];
+} & BaseField & CustomFieldProps$1;
+/**
+ * Field Type Utilities
+ */
 interface BaseField {
     name: string;
     ref?: any;
     multiline?: boolean;
     content?: ReactElement;
     label?: string;
-    labelProps?: InputLabelProps;
+    labelProps?: InputLabelProps$1;
     helperText?: string;
     hidden?: boolean;
     type?: string;
-    helpTextProps?: InputLabelHelpProps;
+    helpTextProps?: InputLabelHelpProps$1;
     validation?: any;
     valueTransformer?: (valueToTransform: string) => string;
     disabled?: boolean;
@@ -867,6 +850,12 @@ interface BaseField {
         sxInputStack?: SxProps<Theme>;
     };
 }
+type CreateFieldType<TFieldType extends string, TProps, TDefaultValue extends any = void> = {
+    fieldType: TFieldType;
+} & BaseField & Omit<TProps, 'value' | 'defaultValue' | 'onChange' | 'name'> & (TDefaultValue extends void ? unknown : {
+    defaultValue?: TDefaultValue;
+});
+type FieldType = FieldTypes['fieldType'];
 
 declare const FormGenerator: FormGeneratorProps;