@app-studio/web 0.8.9 → 0.8.11

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

@@ -1,120 +1,40 @@
 import React, { CSSProperties } from 'react';
 import { InputProps, Shadow } from 'app-studio';
-import { Elevation } from 'src/utils/elevation';
+import { Elevation } from '../../../../utils/elevation';
 import { Shape, Size, TextFieldStyles, Variant } from './TextField.type';
 export interface TextFieldProps extends Omit<InputProps, 'size'> {
-    /**
-     * The input field identifier.
-     */
     id?: string;
-    /**
-     * Specifies whether the input field should display an error state.
-     */
     error?: any;
-    /**
-     * Provides additional information about the input field.
-     */
     helperText?: string;
-    /**
-     * The name of the input field.
-     */
     name?: string;
-    /**
-     * Displays a label above the user input.
-     */
     label?: string;
-    /**
-     * Changes the label and border color of the input field.
-     */
     colorScheme?: string;
-    /**
-     * The left child to include in the field.
-     */
     leftChild?: React.ReactNode;
-    /**
-     * The right child to include in the field.
-     */
     rightChild?: React.ReactNode;
-    /**
-     * Placeholder text to display in the input field until the user enters text.
-     */
     placeholder?: 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 a clear button should be added to the input field that clears its value when clicked.
-     */
     isClearable?: boolean;
-    /**
-     * Specifies whether the input field should be automatically focused.
-     */
     isAutoFocus?: boolean;
-    /**
-     * 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?: (value: string) => void;
-    /**
-     * Callback function triggered when the field loses focus.
-     */
     onBlur?: (value: any) => void;
-    /**
-     * Event called when the input field is clicked/pressed.
-     */
     onClick?: () => 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?: TextFieldStyles;
-    /**
-     * The default value of the input field.
-     */
     value?: string;
-    /**
-     * Changes the style variant of the input field.
-     */
     variant?: Variant;
 }
 export interface TextFieldViewProps extends TextFieldProps {
-    /** The hint text for the text field */
     hint?: string;
-    /** Function to set the hint text for the text field */
     setHint?: Function;
-    /** Indicates whether the text field is currently focused or not */
     isFocused?: boolean;
-    /** Function to set the focused state of the text field */
     setIsFocused?: Function;
-    /** Indicates whether the mouse pointer is currently hovering over the text field or not */
     isHovered?: boolean;
-    /** Function to set the hovered state of the text field */
     setIsHovered?: Function;
-    /** The current value of the text field */
     value?: string;
-    /** Function to set the value of the text field */
     setValue?: Function;
 }

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

@@ -1,6 +1,3 @@
 import React from 'react';
 import { TextFieldProps } from './TextField/TextField.props';
-/**
- * TextField is used to capture text data from users.
- */
 export declare const TextField: React.FC<TextFieldProps>;

package/dist/components/Layout/Input/FieldContent/FieldContent/FieldContent.props.d.ts

@@ -1,6 +1,6 @@
 import React, { CSSProperties } from 'react';
 import { Shape, Size, TextFieldStyles, Variant } from '../../../../Layout/configs/Input.type';
-import { Elevation } from 'src/utils/elevation';
+import { Elevation } from '../../../../../utils/elevation';
 import { Shadow, ViewProps } from 'app-studio';
 export interface ContentProps extends Omit<ViewProps, 'size'> {
     /**

package/dist/components/Link/Link/Link.props.d.ts

@@ -2,43 +2,15 @@ import React from 'react';
 import { Size, Styles, TextDecorationStyle } from './Link.type';
 import { ViewProps } from 'app-studio';
 export interface LinkProps extends Omit<ViewProps, 'size'> {
-    /**
-     * The content of the link.
-     */
     children: React.ReactNode;
-    /**
-     * The style of text decoration for the link.
-     * Can be one of "default", "hover", or "underline".
-     */
     underline?: TextDecorationStyle;
-    /**
-     * Indicates whether the link opens in a new tab.
-     */
     isExternal?: boolean;
-    /**
-     * The size of the icon associated with the link.
-     */
     iconSize?: Size;
-    /**
-     * Sets the color of the icon and text.
-     */
     colorScheme?: string;
-    /**
-     * The URL or destination of the link.
-     */
     href: string;
-    /**
-     * CSS styles for the  external icon.
-     */
     styles?: Styles;
 }
 export interface LinkViewProps extends LinkProps {
-    /**
-     *  Indicates whether the link is currently being hovered
-     */
     isHovered: boolean;
-    /**
-     *  Function to set the hovered state of the link
-     */
     setIsHovered: Function;
 }

package/dist/components/Link/Link.d.ts

@@ -1,6 +1,3 @@
 import React from 'react';
 import { LinkProps } from './Link/Link.props';
-/**
- * Link allows users to navigate from page to page. It have a similar appearance as the hyperlink.
- */
 export declare const Link: React.FC<LinkProps>;

package/dist/components/Loader/Loader/Loader.props.d.ts

@@ -1,78 +1,27 @@
 import React from 'react';
 import { LoaderType, Size, Speed, TextPosition } from './Loader.type';
 import { ViewProps } from 'app-studio';
-/**
- * Props for the Loader component.
- */
 export interface LoaderProps extends Omit<ViewProps, 'size'> {
-    /**
-     * The text content.
-     */
     children?: React.ReactNode;
-    /**
-     * The color of the loader.
-     */
     loaderColor?: string;
-    /**
-     * The type of loader.
-     */
     type?: LoaderType;
-    /**
-     * The color of the text.
-     */
     textColor?: string;
-    /**
-     * The position where to place the children.
-     */
     textPosition?: TextPosition;
-    /**
-     * The width and height of the loader.
-     */
     size?: number | Size;
-    /**
-     * The rotation speed of the loader.
-     */
     speed?: Speed;
 }
 export interface DefaultSpinnerProps extends Omit<ViewProps, 'size'> {
-    /**
-     * To set the spinner height and width
-     */
     size?: number | Size;
-    /**
-     * To set the rate at which the spinner moves
-     */
     speed?: Speed;
-    /**
-     * To change the spinner color
-     */
     color?: string;
 }
 export interface DottedProps extends Omit<ViewProps, 'size'> {
-    /**
-     * To set the spinner height and width
-     */
     size?: number | Size;
-    /**
-     * To set the rate at which the spinner moves
-     */
     speed?: Speed;
-    /**
-     * To change the spinner color
-     */
     color?: string;
 }
 export interface QuarterProps extends Omit<ViewProps, 'size'> {
-    /**
-     * To set the spinner height and width
-     */
     size?: number | Size;
-    /**
-     * To set the rate at which the spinner moves
-     */
     speed?: Speed;
-    /**
-     * To change the spinner color
-     */
     color?: string;
 }

package/dist/components/Loader/Loader.d.ts

@@ -1,6 +1,3 @@
 import React from 'react';
 import { LoaderProps } from './Loader/Loader.props';
-/**
- * It  gives the user an insight about an action being processed. It may have an undefined waiting time or display the process length.
- */
 export declare const Loader: React.FC<LoaderProps>;

package/dist/components/Message/Message/Message.props.d.ts

@@ -1,4 +1,4 @@
-import { Message, MessageViewStyles, Position, ThemesType } from './Message.type';
+import { MessageType, MessageViewStyles, Position, ThemesType } from './Message.type';
 export interface MessageLayoutProps {
     icons?: {
         [x: string]: string;
@@ -17,7 +17,7 @@ export interface ShowMessageProps {
 }
 export interface MessageProps extends ShowMessageProps {
     subtitle?: string;
-    variant: Message;
+    variant: MessageType;
     show?: boolean;
     hide: Function;
     title: string;
@@ -25,7 +25,7 @@ export interface MessageProps extends ShowMessageProps {
 }
 export interface MessageState {
     visible: boolean;
-    variant: Message;
+    variant: MessageType;
     title: string;
     subtitle: string;
     isClosable?: boolean;
@@ -34,6 +34,6 @@ export interface MessageState {
     actionText?: string;
     showIcon?: boolean;
     timeout?: number;
-    show: (variant: Message, title?: string, subtitle?: string, isClosable?: boolean, styles?: MessageViewStyles, action?: Function, actionText?: string, showIcon?: boolean, timeout?: number) => void;
+    show: (variant: MessageType, title?: string, subtitle?: string, isClosable?: boolean, styles?: MessageViewStyles, action?: Function, actionText?: string, showIcon?: boolean, timeout?: number) => void;
     hide: () => void;
 }

package/dist/components/Message/Message/Message.store.d.ts

@@ -1,4 +1,4 @@
-import { Message, ShowMessageType } from './Message.type';
+import { MessageType, ShowMessageType } from './Message.type';
 export declare const useMessageStore: any;
-export declare const showMessage: (variant: Message, title?: string | undefined, subtitle?: string | undefined, props?: ShowMessageType | undefined) => void;
+export declare const showMessage: (variant: MessageType, title?: string | undefined, subtitle?: string | undefined, props?: ShowMessageType | undefined) => void;
 export declare const hideMessage: () => void;

package/dist/components/Message/Message/Message.style.d.ts

@@ -1,5 +1,5 @@
 import { CSSProperties } from 'react';
-import { Message, Shape, Size } from './Message.type';
+import { MessageType, Shape, Size } from './Message.type';
 export declare const ContainerShapes: Record<Shape, CSSProperties>;
 export declare const HeaderIconSizes: Record<Size, number>;
-export declare const Themes: Record<Message, any>;
+export declare const Themes: Record<MessageType, any>;

package/dist/components/Message/Message/Message.type.d.ts

@@ -0,0 +1,47 @@
+export declare type Position = 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
+export declare type Shape = 'sharp' | 'rounded';
+export declare type CloseButtonPosition = 'left' | 'right' | 'none';
+export declare type Size = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+export declare type MessageType = 'info' | 'warning' | 'error' | 'success';
+export declare type MessageViewStyles = {
+    container?: any;
+    title?: any;
+    subtitle?: any;
+    icon?: any;
+    actionText?: any;
+    closingIcon?: {
+        container?: any;
+        icon?: any;
+    };
+};
+export declare type Theme = {
+    container: {
+        backgroundColor?: string;
+        border?: string;
+    };
+    icon: {
+        color?: string;
+        name?: string;
+    };
+    content: {
+        color?: string;
+    };
+    close: {
+        color?: string;
+        name?: string;
+    };
+};
+export declare type ThemesType = {
+    info: Theme;
+    success: Theme;
+    error: Theme;
+    warning: Theme;
+};
+export declare type ShowMessageType = {
+    isClosable?: boolean;
+    styles?: MessageViewStyles;
+    action?: Function;
+    actionText?: string;
+    showIcon?: boolean;
+    timeout?: number;
+};

package/dist/components/Message/Message.d.ts

@@ -1,5 +1,5 @@
 export { MessageLayout } from './Message/Message.layout';
 export { MessageView } from './Message/Message.view';
-export { MessageProps } from './Message/Message.props';
-export { Message } from './Message/Message.type';
+export type { MessageProps } from './Message/Message.props';
+export type { MessageType } from './Message/Message.type';
 export * from './Message/Message.store';

package/dist/components/Modal/Modal/Modal.props.d.ts

@@ -1,5 +1,5 @@
 import React, { CSSProperties } from 'react';
-import { Elevation } from 'src/utils/elevation';
+import { Elevation } from '../../../utils/elevation';
 import { Shadow, ViewProps } from 'app-studio';
 import { CloseButtonPosition, Position, Shape, Size } from './Modal.type';
 export interface ModalProps extends Omit<ViewProps, 'size'> {

package/dist/components/Text/Text/Text.props.d.ts

@@ -2,72 +2,24 @@ import { CSSProperties } from 'react';
 import type { TextProps as TextAppProps } from 'app-studio';
 import { Headings, Size, TextWeights } from './Text.type';
 export interface TextProps extends Omit<TextAppProps, 'children' | 'style' | 'pointerEvents'>, CSSProperties {
-    /**
-     * The content of the text.
-     */
     children: React.ReactNode;
-    /**
-     * Specifies the HTML heading tag to use.
-     */
     heading?: Headings;
-    /**
-     * Determines whether the text should be displayed in italic style.
-     */
     isItalic?: boolean;
-    /**
-     * Indicates that the text is no longer valid by applying a strikethrough style.
-     */
     isStriked?: boolean;
-    /**
-     * Adds an underline to the text.
-     */
     isUnderlined?: boolean;
-    /**
-     * Truncates the text and adds an ellipsis at the end if it exceeds the available space.
-     */
     isTruncated?: boolean;
-    /**
-     * Displays the text slightly below the baseline of the surrounding text.
-     */
     isSub?: boolean;
-    /**
-     * Displays the text slightly above the surrounding text.
-     */
     isSup?: boolean;
-    /**
-     * The maximum number of lines to display when using text truncation.
-     */
     maxLines?: number;
-    /**
-     * Adjusts the size of the text. Can be a predefined size or a custom number.
-     */
     size?: Size;
-    /**
-     * Specifies the font weight of the text.
-     */
     weight?: TextWeights;
 }
 export interface ContentProps {
-    /**
-     * The content to be rendered within the component.
-     */
     children: React.ReactNode | string;
-    /**
-     * Optional prop indicating if the content should be displayed as a subtext.
-     */
     isSub?: boolean;
-    /**
-     * Optional prop indicating if the content should be displayed as a supertext.
-     */
     isSup?: boolean;
 }
 export interface TruncateTextProps {
-    /**
-     * The text to be truncated.
-     */
     text: string;
-    /**
-     * The maximum number of lines to display before truncating the text.
-     */
     maxLines?: number;
 }

package/dist/docsLoader.d.ts

@@ -0,0 +1 @@
+export function loadDocs(): Promise<[any, any, any, any, any, any, any, any, any, any] | never[]>;

package/dist/pages/docs/components/LiveCode.component.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const LiveCode: ({ code, language, scope }: any) => React.JSX.Element;
+export default LiveCode;

package/dist/pages/docs/components/MarkdownEditor.component.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import '@mdxeditor/editor/style.css';
+export declare const MarkdownEditor: ({ markdown }: {
+    markdown: string;
+}) => React.JSX.Element;

package/dist/pages/docs/components/docs.elements.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+export declare const SideMenu: ({ docs, ...props }: any) => React.JSX.Element;
+export declare const Text1: () => React.JSX.Element;

package/dist/pages/docs/components/docs.request.d.ts

@@ -0,0 +1,10 @@
+export declare type Sections = {
+    title: string;
+    items?: {
+        name: string;
+        link: string;
+    }[];
+}[];
+export declare const useDocsRequest: () => {
+    sections: Sections;
+};

package/dist/pages/docs/components/docs.states.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare function useHomePageStates(): {
+    inputValue: string;
+    setInputValue: import("react").Dispatch<import("react").SetStateAction<string>>;
+};

package/dist/pages/docs/docs.page.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import '@mdxeditor/editor/style.css';
+declare const DocsPage: () => React.JSX.Element;
+export default DocsPage;