Merge pull request #2283 from gluestack/feat/documentation-changes

surajahmed · web-flow · commit eeedb82e53cd · 2024-07-10T18:22:16.000+05:30
feat: description updated in components
diff --git a/example/storybook-nativewind/src/components/Accordion/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Accordion/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: Accordion | gluestack-ui | Installation, Usage, and API
 
-description: The Accordion component is a versatile and interactive user interface element, designed to efficiently organize and present content in a compact space.
+description: Efficiently organize and present content in a compact, interactive interface.
 
 pageTitle: Accordion
 
-pageDescription: The Accordion component is a versatile and interactive user interface element, designed to efficiently organize and present content in a compact space.
+pageDescription: Efficiently organize and present content in a compact, interactive interface.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Actionsheet/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Actionsheet/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: Actionsheet | gluestack-ui | Installation, Usage, and API
 
-description: The Actionsheet component presents a set of options to the user, overlaid on top of the app's content, allowing them to take quick actions without leaving the current page or view.
+description: Quickly access options overlaying the app's content for efficient user actions.
 
 pageTitle: Actionsheet
 
-pageDescription: The Actionsheet component presents a set of options to the user, overlaid on top of the app's content, allowing them to take quick actions without leaving the current page or view.
+pageDescription: Quickly access options overlaying the app's content for efficient user actions.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Alert/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Alert/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Alert Component | Installation, Usage, and API
 
-description: Alerts are used to communicate the status of a system, feature, or page. They indicate a specific state that may require attention from the user.
+description: Status indicators notify users of important system, feature, or page conditions that require attention.
 
 pageTitle: Alert
 
-pageDescription: Alerts are used to communicate the status of a system, feature, or page. They indicate a specific state that may require attention from the user.
+pageDescription: Status indicators notify users of important system, feature, or page conditions that require attention.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/AlertDialog/index.nw.stories.mdx b/example/storybook-nativewind/src/components/AlertDialog/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui AlertDialog Component | Installation, Usage, and API
 
-description: AlertDialog effectively interrupts a user's flow and prompts them to take a specific action. It's commonly used for mandatory confirmations or call-to-actions.
+description: Prompt users to take action with interruptions for confirmations or important prompts.
 
 pageTitle: AlertDialog
 
-pageDescription: AlertDialog effectively interrupts a user's flow and prompts them to take a specific action. It's commonly used for mandatory confirmations or call-to-actions.
+pageDescription: Prompt users to take action with interruptions for confirmations or important prompts.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Avatar/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Avatar/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Avatar Component | Installation, Usage, and API
 
-description: The Avatar component is a versatile UI element representing a user with profile pictures, initials, or a fallback icon. It adds a personal touch to the user interface, making it more engaging.
+description: Enhance UI engagement with a versatile element showing user profiles via pictures, initials, or icons
 
 pageTitle: Avatar
 
-pageDescription: The Avatar component is a versatile UI element representing a user with profile pictures, initials, or a fallback icon. It adds a personal touch to the user interface, making it more engaging.
+pageDescription: Enhance UI engagement with a versatile element showing user profiles via pictures, initials, or icons
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Badge/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Badge/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Badge Component | Installation, Usage, and API
 
-description: The badge component lets you quickly and easily add status indicators to your interface for improved usability. They are designed to be attention-grabbing and quickly convey important information.
+description: Add status indicators to your interface for clear, attention-grabbing usability cues, conveying crucial information swiftly.
 
 pageTitle: Badge
 
-pageDescription: The badge component lets you quickly and easily add status indicators to your interface for improved usability. They are designed to be attention-grabbing and quickly convey important information.
+pageDescription: Add status indicators to your interface for clear, attention-grabbing usability cues, conveying crucial information swiftly.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Box/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Box/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Box Component | Installation, Usage, and API
 
-description: If you're looking for a flexible component to help with low-level layout needs, the Box component might be just what you need. With its customizable styles and props, it can be used to create a wide range of UI elements, from simple containers to complex layout structures.
+description: Flexible layout tool with customizable styles and props for simple to complex structures.
 
 pageTitle: Box
 
-pageDescription: If you're looking for a flexible component to help with low-level layout needs, the Box component might be just what you need. With its customizable styles and props, it can be used to create a wide range of UI elements, from simple containers to complex layout structures.
+pageDescription: Flexible layout tool with customizable styles and props for simple to complex structures.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Button/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Button/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Button Component | Installation, Usage, and API
 
-description: A button component is a graphical user interface element that enables users to act by clicking or tapping. It can be customized in size, shape, color, and behavior to fit the design of the application or website.
+description: Trigger an action or event with customizable size, shape, color, and behavior.
 
 pageTitle: Button
 
-pageDescription: A button component is a graphical user interface element that enables users to act by clicking or tapping. It can be customized in size, shape, color, and behavior to fit the design of the application or website.
+pageDescription: Trigger an action or event with customizable size, shape, color, and behavior.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Center/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Center/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Center Component | Installation, Usage, and API
 
-description: When you need to center-align content, the Center component comes in handy. It is a layout component that can be used with other components to create complex layouts and positioning.
+description: Helps center-align content and can create complex layouts easily.
 
 pageTitle: Center
 
-pageDescription: When you need to center-align content, the Center component comes in handy. It is a layout component that can be used with other components to create complex layouts and positioning.
+pageDescription: Helps center-align content and can create complex layouts easily.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Checkbox/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Checkbox/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Checkbox Component | Installation, Usage, and API
 
-description: Whether you're building a simple form or a complex data collection system, the Checkbox component offers a user-friendly way for users to select multiple options from a list.
+description: Base input element to toggle options on and off, ideal for forms and data systems.
 
 pageTitle: Checkbox
 
-pageDescription: Whether you're building a simple form or a complex data collection system, the Checkbox component offers a user-friendly way for users to select multiple options from a list.
+pageDescription: Base input element to toggle options on and off, ideal for forms and data systems.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Divider/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Divider/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Divider Component | Installation, Usage, and API
 
-description: Revamp your content organization with the Divider component! Use it to visually separate different sections of a list or group for a more structured and easy-to-read interface.
+description: Organize content visually with separators for a more structured, easy-to-read interface.
 
 pageTitle: Divider
 
-pageDescription: Revamp your content organization with the Divider component! Use it to visually separate different sections of a list or group for a more structured and easy-to-read interface.
+pageDescription: Organize content visually with separators for a more structured, easy-to-read interface.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Fab/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Fab/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Fab Component | Installation, Usage, and API
 
-description: The Floating Action Button (FAB) is a dynamic button that stays visible and provides access to a primary action throughout the user's journey in the application. It is a powerful UI element that adds a touch of elegance and convenience to the user experience.
+description: A dynamic button that stays visible, offering convenient access to a primary action.
 
 pageTitle: Fab
 
-pageDescription: The Floating Action Button (FAB) is a dynamic button that stays visible and provides access to a primary action throughout the user's journey in the application. It is a powerful UI element that adds a touch of elegance and convenience to the user experience.
+pageDescription: A dynamic button that stays visible, offering convenient access to a primary action.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/FormControl/index.nw.stories.mdx b/example/storybook-nativewind/src/components/FormControl/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui FormControl Component | Installation, Usage, and API
 
-description: By using FormControl, developers can provide important context to form elements. This context can include whether the element is invalid, disabled, or required.
+description: Provide context to form elements, such as invalid, disabled, or required states.
 
 pageTitle: FormControl
 
-pageDescription: By using FormControl, developers can provide important context to form elements. This context can include whether the element is invalid, disabled, or required.
+pageDescription: Provide context to form elements, such as invalid, disabled, or required states.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Grid/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Grid/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Grid Component | Installation, Usage, and API
 
-description: The Grid component is a versatile layout tool designed to facilitate the creation of grid-based layouts comprising rows and columns. It offers flexibility and robust functionality, enabling the creation of diverse UI elements, ranging from basic containers to intricate layout structures.
+description: Utilize a versatile layout tool for creating grid-based UIs with rows and columns. Flexible and robust for diverse layout structures.
 
 pageTitle: Grid
 
-pageDescription: The Grid component is a versatile layout tool designed to facilitate the creation of grid-based layouts comprising rows and columns. It offers flexibility and robust functionality, enabling the creation of diverse UI elements, ranging from basic containers to intricate layout structures.
+pageDescription: Utilize a versatile layout tool for creating grid-based UIs with rows and columns. Flexible and robust for diverse layout structures.
 
 showHeader: true
 
diff --git a/example/storybook-nativewind/src/components/HStack/index.nw.stories.mdx b/example/storybook-nativewind/src/components/HStack/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui HStack Component | Installation, Usage, and API
 
-description: HStack arranges its child elements horizontally, making it a suitable layout component for creating a row of items. It is worth noting that Row is just an alternative name for HStack.
+description: HStack is a layout component for arranging elements horizontally.
 
 pageTitle: HStack
 
-pageDescription: HStack arranges its child elements horizontally, making it a suitable layout component for creating a row of items. It is worth noting that Row is just an alternative name for HStack.
+pageDescription: HStack is a layout component for arranging elements horizontally.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Heading/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Heading/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Heading Component | Installation, Usage, and API
 
-description: Heading component gives you the ability to create headings for your page with different sizes and semantics from h1 to h6.
+description: Generates headings from h1 to h6 with different sizes and semantic meanings.
 
 pageTitle: Heading
 
-pageDescription: Heading component gives you the ability to create headings for your page with different sizes and semantics from h1 to h6.
+pageDescription: Generates headings from h1 to h6 with different sizes and semantic meanings.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Icon/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Icon/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Icon Component | Installation, Usage, and API
 
-description: Icons are often used to enhance the usability and accessibility of digital products by providing users with clear and intuitive visual cues. It serves as an intuitive and easily recognizable way to communicate with users.
+description: Icons provide clear, intuitive visual cues for better usability and accessibility in digital products.
 
 pageTitle: Icon
 
-pageDescription: Icons are often used to enhance the usability and accessibility of digital products by providing users with clear and intuitive visual cues. It serves as an intuitive and easily recognizable way to communicate with users.
+pageDescription: Icons provide clear, intuitive visual cues for better usability and accessibility in digital products.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Image/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Image/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Image Component | Installation, Usage, and API
 
-description: With the Image component, you can enhance the look and feel of your app or website by incorporating compelling imagery.
+description: Enhance your app or website with captivating visuals using our Image feature.
 
 pageTitle: Image
 
-pageDescription: With the Image component, you can enhance the look and feel of your app or website by incorporating compelling imagery.
+pageDescription: Enhance your app or website with captivating visuals using our Image feature.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Input/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Input/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Input Component | Installation, Usage, and API
 
-description: The Input component is your go-to tool for gathering user input in a sleek and user-friendly text field. Whether you're designing a simple login form or a complex search feature, this component has got you covered.
+description: Gather user input with a sleek, user-friendly text field for forms and search features.
 
 pageTitle: Input
 
-pageDescription: The Input component is your go-to tool for gathering user input in a sleek and user-friendly text field. Whether you're designing a simple login form or a complex search feature, this component has got you covered.
+pageDescription: Gather user input with a sleek, user-friendly text field for forms and search features.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Link/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Link/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Link Component | Installation, Usage, and API
 
-description: With links, users can navigate seamlessly throughout a website. This component has a hyperlinked appearance for a user-friendly experience.
+description: Enable seamless navigation with hyperlinked text for a user-friendly website experience.
 
 pageTitle: Link
 
-pageDescription: With links, users can navigate seamlessly throughout a website. This component has a hyperlinked appearance for a user-friendly experience.
+pageDescription: Enable seamless navigation with hyperlinked text for a user-friendly website experience.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Menu/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Menu/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Menu Component | Installation, Usage, and API
 
-description: The Menu component creates a user-friendly dropdown interface that can be utilized to present a range of options or actions. This feature ensures accessibility and ease of use for the user.
+description: Enhance usability with a dropdown interface for presenting options or actions, ensuring accessibility.
 
 pageTitle: Menu
 
-pageDescription: The Menu component creates a user-friendly dropdown interface that can be utilized to present a range of options or actions. This feature ensures accessibility and ease of use for the user.
+pageDescription: Enhance usability with a dropdown interface for presenting options or actions, ensuring accessibility.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Modal/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Modal/index.nw.stories.mdx
@@ -1,12 +1,10 @@
 ---
 title: Modal | gluestack-ui | Installation, Usage, and API
 
-description: A Modal is a window on top of the primary content to draw the user's attention to important information or actions. It provides a focused and interruptive way to interact with the application.
-
+description: Highlight key information or actions with a window that overlays content for focused interaction.
 pageTitle: Modal
 
-pageDescription: A Modal is a window on top of the primary content to draw the user's attention to important information or actions. It provides a focused and interruptive way to interact with the application.
-
+pageDescription: Highlight key information or actions with a window that overlays content for focused interaction.
 showHeader: true
 ---
 
diff --git a/example/storybook-nativewind/src/components/Popover/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Popover/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Popover Component | Installation, Usage, and API
 
-description: Popovers often provide contextual information or quick access to related actions without requiring the user to navigate to a different page or view.
+description: Contextual pop-ups offer info or actions conveniently, enhancing user flow without page changes.
 
 pageTitle: Popover
 
-pageDescription: Popovers often provide contextual information or quick access to related actions without requiring the user to navigate to a different page or view.
+pageDescription: Contextual pop-ups offer info or actions conveniently, enhancing user flow without page changes.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Pressable/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Pressable/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Pressable Component | Installation, Usage, and API
 
-description: By providing access to hover, pressed, and focus events, Pressable serves as a more flexible alternative to buttons at a lower level of abstraction. It is a useful primitive for advanced customization needs.
+description: Access hover, pressed, and focus events for flexible, customizable button alternatives.
 
 pageTitle: Pressable
 
-pageDescription: By providing access to hover, pressed, and focus events, Pressable serves as a more flexible alternative to buttons at a lower level of abstraction. It is a useful primitive for advanced customization needs.
+pageDescription: Access hover, pressed, and focus events for flexible, customizable button alternatives.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Progress/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Progress/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Progress Component | Installation, Usage, and API
 
-description: The Progress component is designed to display the progress of a task that involves multiple steps and takes some time to complete. It helps users stay informed about the current status of a lengthy process.
+description: Track task progression across multiple steps, keeping users updated on lengthy processes.
 
 pageTitle: Progress
 
-pageDescription: The Progress component is designed to display the progress of a task that involves multiple steps and takes some time to complete. It helps users stay informed about the current status of a lengthy process.
+pageDescription: Track task progression across multiple steps, keeping users updated on lengthy processes.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Radio/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Radio/index.nw.stories.mdx
@@ -1,11 +1,11 @@
 ---
 title: gluestack-ui Radio Component | Installation, Usage, and API
 
-description: The Radio component presents users with predefined choices and enables them to select only one option. It is commonly used for providing a single-choice selection in forms or surveys.
+description: Standalone radio button for use in any layout, offering predefined choices for selection.
 
 pageTitle: Radio
 
-pageDescription: The Radio component presents users with predefined choices and enables them to select only one option. It is commonly used for providing a single-choice selection in forms or surveys.
+pageDescription: Standalone radio button for use in any layout, offering predefined choices for selection.
 
 showHeader: true
 ---
diff --git a/example/storybook-nativewind/src/components/Select/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Select/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Skeleton/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Skeleton/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Slider/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Slider/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Spinner/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Spinner/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Switch/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Switch/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Table/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Table/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Text/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Text/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Textarea/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Textarea/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Toast/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Toast/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/Tooltip/index.nw.stories.mdx b/example/storybook-nativewind/src/components/Tooltip/index.nw.stories.mdx
diff --git a/example/storybook-nativewind/src/components/VStack/index.nw.stories.mdx b/example/storybook-nativewind/src/components/VStack/index.nw.stories.mdx
