@app-studio/web 0.8.10 → 0.8.13

package/dist/components/Form/CountryPicker/CountryPicker/CountryPicker.props.d.ts

@@ -3,159 +3,46 @@ import { Elevation } from '../../../../utils/elevation';
 import { InputProps, Shadow } from 'app-studio';
 import { Country, CountryPickerStyles, Shape, Size, Variant } from './CountryPicker.type';
 export interface CountryPickerProps extends Omit<InputProps, 'size'> {
-    /**
-     * The identifier for the CountryPicker component.
-     */
     id?: string;
-    /**
-     * Indicates whether the field has an error.
-     */
     error?: boolean;
-    /**
-     * The name of the field.
-     */
     name?: string;
-    /**
-     * The label text for the field.
-     */
     label?: string;
-    /**
-     * The color scheme that changes the border color on hover of the field.
-     */
     colorScheme?: string;
-    /**
-     * Additional helper text that provides information about the field.
-     */
     helperText?: string;
-    /**
-     * A brief text or hint that appears in the field before the user enters any value.
-     */
     placeholder?: string;
-    /**
-     * The shape that changes the outlines of the CountryPicker.
-     */
     shape?: Shape;
-    /**
-     * If true, the field will be automatically focused.
-     */
     isAutoFocus?: boolean;
-    /**
-     * If true, the CountryPicker cannot be edited.
-     */
     isReadOnly?: boolean;
-    /**
-     * If true, the field will be unusable.
-     */
     isDisabled?: boolean;
-    /**
-     * Callback function triggered when the CountryPicker loses focus.
-     */
     onBlur?: (value: any) => void;
-    /**
-     * Callback function triggered when the field value changes.
-     */
     onChange?: (value: any) => void;
-    /**
-     * CSS styles for the CountryPicker component.
-     */
     styles?: CountryPickerStyles;
-    /**
-     * The font size of the CountryPicker.
-     */
     size?: Size;
-    /**
-     * The default value of the input field.
-     */
     value?: string | number;
-    /**
-     * Changes the style of the input field.
-     */
     variant?: Variant;
-    /**
-     * Adds a shadow effect to the CountryPicker.
-     */
     shadow?: Shadow | Elevation | CSSProperties;
 }
 export interface CountryPickerViewProps extends CountryPickerProps {
-    /**
-     * Indicates whether the country picker is currently being hovered.
-     */
     isHovered?: boolean;
-    /**
-     * A function to set the hovered state of the country picker.
-     * @param hovered - The hovered state to set.
-     */
     setIsHovered?: (hovered: boolean) => void;
-    /**
-     * Indicates whether the country picker is focused.
-     */
     isFocused?: boolean;
-    /**
-     * A function to set the focus state of the country picker.
-     * @param focused - The focus state to set.
-     */
     setIsFocused?: (focused: boolean) => void;
-    /**
-     * Indicates the currently selected country.
-     */
     selected?: string;
-    /**
-     * A function to set the selected country.
-     * @param selected - The selected country to set.
-     */
     setSelected?: (selected: string) => void;
-    /**
-     * Indicates whether the country picker should be hidden.
-     */
     hide?: boolean;
-    /**
-     * A function to set the hide state of the country picker.
-     * @param hide - The hide state to set.
-     */
     setHide?: (hide: boolean) => void;
-    /**
-     * Options for the country picker.
-     */
     newOptions?: Array<Country>;
-    /**
-     * A function to set the new options for the country picker.
-     * @param newOptions - The new options to set.
-     */
     setNewOptions?: (newOptions: Array<Country>) => void;
 }
 export interface DropDownProps extends Omit<InputProps, 'size'> {
-    /**
-     * To set the height and width of the item list.
-     */
     size?: Size;
-    /**
-     * Function that will be called when the option is CountryPickered
-     */
     callback?: Function;
-    /**
-     * List of options
-     */
     options: Array<Country>;
-    /**
-     * Css styles for the CountryPicker container and label
-     */
     styles?: CountryPickerStyles;
 }
 export interface DropDownItemProps extends Omit<InputProps, 'size'> {
-    /**
-     * Function that will be called when the option is clicked
-     */
     callback?: Function;
-    /**
-     * Option to be displayed
-     */
     option: string;
-    /**
-     * To set the DropDownItem's fontSize
-     */
     size?: Size;
-    /**
-     * Css styles
-     */
     styles?: CountryPickerStyles;
 }

package/dist/components/Form/CountryPicker/CountryPicker.d.ts

@@ -1,6 +1,3 @@
 import React from 'react';
 import { CountryPickerProps } from './CountryPicker/CountryPicker.props';
-/**
- * Country picker allows users to select a country from a dropdown list or search field.
- */
 export declare const CountryPicker: React.FC<CountryPickerProps>;

package/dist/components/Form/Select/Select/Select.props.d.ts

@@ -3,218 +3,68 @@ import { Elevation } from '../../../../utils/elevation';
 import { InputProps, Shadow } from 'app-studio';
 import { SelectStyles, Shape, Size, Variant, Option } from './Select.type';
 export interface SelectProps extends Omit<InputProps, 'size'> {
-    /**
-     * The identifier of the select field.
-     */
     id?: string;
-    /**
-     * Indicates whether the field has an error.
-     */
     error?: boolean;
-    /**
-     * The name of the select field.
-     */
     name?: string;
-    /**
-     * The label text for the select field.
-     */
     label?: string;
-    /**
-     * Changes the border color when hovering over the field.
-     */
     colorScheme?: string;
-    /**
-     * Provides additional information or instructions about the field.
-     */
     helperText?: string;
-    /**
-     * A brief text or hint that appears in the field before the user enters any value.
-     */
     placeholder?: string;
-    /**
-     * An array of options for the select field.
-     */
     options: Option[];
-    /**
-     * If true, allows multiple options to be selected.
-     */
     isMulti?: boolean;
-    /**
-     * If true, the select field cannot be edited.
-     */
     isReadOnly?: boolean;
-    /**
-     * If true, the select field is disabled and cannot be used.
-     */
     isDisabled?: boolean;
-    /**
-     * Handler function to be called when the select value changes.
-     */
     onChange?: (value: any) => void;
-    /**
-     * Changes the shape or outline of the input field.
-     */
     shape?: Shape;
-    /**
-     * Changes the style variant of the input field.
-     */
     variant?: Variant;
-    /**
-     * CSS styles for the select box and dropdown.
-     */
     styles?: SelectStyles;
-    /**
-     * Specifies the height and width of the select.
-     */
     size?: Size;
-    /**
-     * Applies a shadow effect to the select field.
-     */
     shadow?: Shadow | Elevation | CSSProperties;
     isScrollable?: boolean;
 }
 export interface SelectViewProps extends SelectProps {
-    /**
-     * Optional prop indicating if an option is selected
-     */
     value: string | Array<string>;
-    /**
-     * Optional callback prop to update the selected option
-     */
     setValue: Function;
-    /**
-     * Prop to determine if the select dropdown is hidden
-     */
     hide: boolean;
-    /**
-     * Callback prop to update the visibility of the select dropdown
-     */
     setHide: Function;
-    /**
-     * Prop indicating if the select is being hovered
-     */
     isHovered: boolean;
-    /**
-     * Callback prop to update the hover state of the select
-     */
     setIsHovered: Function;
-    /**
-     * Prop indicating if the select is currently focused
-     */
     isFocused: boolean;
-    /**
-     * Callback prop to update the focus state of the select
-     */
     setIsFocused: Function;
 }
 export interface SelectBoxProps {
     options: Option[];
-    /**
-     * The option that will be selected value
-     */
     value?: string | Array<string>;
-    /**
-     * If true, the select will be unusable
-     */
     isDisabled?: boolean;
-    /**
-     * A brief text or hint that appears in the field before the user enters any value
-     */
     placeholder?: string;
-    /**
-     * Function to be called when clicked on close button
-     */
     removeOption?: Function;
-    /**
-     * Css styles for the select box and dropdown
-     */
     styles?: SelectStyles;
-    /**
-     * To set the select's height and width.
-     */
     size?: Size;
 }
 export interface MultiSelectProps extends Omit<InputProps, 'size'> {
-    /**
-     * Option to be displayed
-     */
     option: string;
-    /**
-     * Function to be called when clicked on close button
-     */
     removeOption: Function;
-    /**
-     * To set the item's fontSize
-     */
     size?: Size;
 }
 export interface ItemProps extends Omit<InputProps, 'size'> {
-    /**
-     * Function that will be called when the option is clicked
-     */
     callback?: Function;
-    /**
-     * Option to be displayed
-     */
     option: Option;
-    /**
-     * To set the item's fontSize
-     */
     size?: Size;
-    /**
-     * Css styles for the Item
-     */
     style?: SelectStyles;
 }
 export interface HiddenSelectProps extends Omit<InputProps, 'size'> {
-    /**
-     * Identifier
-     */
     id?: string;
-    /**
-     * The name of the field
-     */
     name?: string;
-    /**
-     * The option that has been selected
-     */
     value: string | Array<string>;
-    /**
-     * If true, multiple options can be selected
-     */
     isMulti?: boolean;
-    /**
-     * If true, select cannot be selected
-     */
     isReadOnly?: boolean;
-    /**
-     * If true, the dropdown will be unusable
-     */
     isDisabled?: boolean;
-    /**
-     * Handler when the field value changes
-     */
     onChange?: (value: any) => void;
-    /**
-     * List of options
-     */
     options: Option[];
 }
 export interface DropDownProps extends Omit<InputProps, 'size'> {
-    /**
-     * To set the height and width of the item list.
-     */
     size?: Size;
-    /**
-     * Function that will be called when the option is selected
-     */
     callback?: Function;
-    /**
-     * List of options
-     */
     options: Option[];
-    /**
-     * Css styles for the select container and label
-     */
     styles?: SelectStyles;
 }

package/dist/components/Form/Select/Select.d.ts

@@ -1,6 +1,3 @@
 import React from 'react';
 import { SelectProps } from './Select/Select.props';
-/**
- * Select provides a dropdown list of options for the user to choose from.
- */
 export declare const Select: React.FC<SelectProps>;

package/dist/components/Form/Switch/Switch/Switch.props.d.ts

@@ -3,62 +3,22 @@ import { Elevation } from '../../../../utils/elevation';
 import { InputProps, Shadow } from 'app-studio';
 import { Size, SwitchStyles } from './Switch.type';
 export interface SwitchProps extends Omit<InputProps, 'size'> {
-    /**
-     * The content to be rendered when the switch is active.
-     */
     activeChild?: React.ReactNode;
-    /**
-     * Specifies the color scheme for the switch's background.
-     */
     colorScheme?: string;
-    /**
-     * Specifies the unique identifier of the switch.
-     */
     id?: string;
-    /**
-     * If set to true, the switch is disabled and cannot be interacted with.
-     */
     isDisabled?: boolean;
-    /**
-     * If set to true, the switch cannot be turned on or off and is in read-only mode.
-     */
     isReadOnly?: boolean;
-    /**
-     * A callback function that is invoked when the switch's value changes.
-     */
     onChange?: Function;
-    /**
-     * The name of the switch.
-     */
     name?: string;
-    /**
-     * The content to be rendered when the switch is inactive.
-     */
     inActiveChild?: React.ReactNode;
-    /**
-     * Custom CSS styles for the switch container and its components.
-     */
     styles?: SwitchStyles;
-    /**
-     * Adds a shadow effect to the switch.
-     */
     shadow?: Shadow | Elevation | CSSProperties;
-    /**
-     * Specifies the size of the switch, affecting its height and width.
-     */
     size?: Size;
-    /**
-     * Label position
-     */
     labelPosition?: 'left' | 'right';
 }
 export interface SwitchViewProps extends SwitchProps {
-    /** Prop indicating if the switch is being hovered */
     isHovered: boolean;
-    /** Callback prop to update the hover state of the switch */
     setIsHovered: Function;
-    /** Prop indicating the current state of the switch */
     value?: boolean;
-    /** Callback prop to update the state of the switch */
     setValue?: Function;
 }

package/dist/components/Form/TextArea/TextArea/TextArea.props.d.ts

@@ -3,138 +3,39 @@ import { InputProps, Shadow } from 'app-studio';
 import { Elevation } from '../../../../utils/elevation';
 import { Shape, Size, TextAreaStyles, Variant } from './TextArea.type';
 export interface TextAreaProps extends Omit<InputProps, 'size'> {
-    /**
-     * Changes the label and border color of the input field.
-     */
     colorScheme?: string;
-    /**
-     * Sets the initial value of the textarea.
-     */
     defaultValue?: string;
-    /**
-     * Specifies whether the input field should display an error state.
-     */
     error?: boolean;
-    /**
-     * Specifies whether the text input is editable or not for iOS and Android.
-     */
     isEditable?: boolean;
-    /**
-     * Provides additional information about the input field.
-     */
     helperText?: string;
-    /**
-     * The input field identifier.
-     */
     id?: string;
-    /**
-     * Specifies whether the input field is read-only and cannot be edited.
-     */
     isReadOnly?: boolean;
-    /**
-     * Specifies whether the input field is disabled and cannot be interacted with.
-     */
     isDisabled?: boolean;
-    /**
-     * Specifies whether the input field should be automatically focused.
-     */
     isAutoFocus?: boolean;
-    /**
-     * Specifies whether the input field should allow multiple lines of text.
-     */
     isMultiline?: boolean;
-    /**
-     * Displays a label above the user input.
-     */
     label?: string;
-    /**
-     * Specifies the maximum number of rows that the textarea should display.
-     */
     maxRows?: number;
-    /**
-     * Specifies the maximum number of columns that the textarea should display.
-     */
     maxCols?: number;
-    /**
-     * The name of the input field.
-     */
     name: string;
-    /**
-     * Placeholder text to display in the input field until the user enters text.
-     */
     placeholder?: string;
-    /**
-     * Handler function called when the input field value changes.
-     */
     onChange?: (value: any) => void;
-    /**
-     * Handler function called when the input field value changes for iOS and Android.
-     */
     onChangeText?: (text: string) => void;
-    /**
-     * Callback function triggered when the field loses focus.
-     */
     onBlur?: (value: any) => void;
-    /**
-     * Callback function called when the text input receives focus.
-     */
     onFocus?: () => void;
-    /**
-     * Sets the text size and padding of the input field.
-     */
     size?: Size;
-    /**
-     * Applies a shadow effect to the input field.
-     */
     shadow?: Shadow | Elevation | CSSProperties;
-    /**
-     * Changes the shape or outline of the input field.
-     */
     shape?: Shape;
-    /**
-     * CSS styles for the input container and field.
-     */
     styles?: TextAreaStyles;
-    /**
-     * The default value of the input field.
-     */
     value?: string | number;
-    /**
-     * Changes the style variant of the input field.
-     */
     variant?: Variant;
 }
 export interface TextAreaViewProps extends TextAreaProps {
-    /**
-     * The hint text displayed in the textarea.
-     */
     hint?: string;
-    /**
-     * Callback prop to update the hint text.
-     */
     setHint?: Function;
-    /**
-     * Prop indicating if the textarea is being hovered.
-     */
     isHovered?: boolean;
-    /**
-     * Callback prop to update the hover state of the textarea.
-     */
     setIsHovered?: Function;
-    /**
-     * The current value of the textarea input.
-     */
     value?: string | number;
-    /**
-     * Callback prop to update the value of the textarea input.
-     */
     setValue?: Function;
-    /**
-     * Prop indicating if the textarea is currently focused.
-     */
     isFocused?: boolean;
-    /**
-     * Callback prop to update the focus state of the textarea.
-     */
     setIsFocused?: Function;
 }

package/dist/components/Form/TextArea/TextArea.d.ts

@@ -1,6 +1,3 @@
 import React from 'react';
 import { TextAreaProps } from './TextArea/TextArea.props';
-/**
- * Text Area is an component used to create a multi-line input field.
- */
 export declare const TextArea: React.FC<TextAreaProps>;