Merge pull request #1477 from vtexdocs/EDU-13415-fs-components-organisms

EDU-13415: Review FastStore components' name (Organisms)
vtexdocs · Oct 3, 2024 · 5326dfb · 5326dfb
2 parents 5392290 + e56bbdf
commit 5326dfb
Show file tree

Hide file tree

Showing 20 changed files with 79 additions and 79 deletions.
diff --git a/docs/faststore/components/organisms/banner-text.mdx b/docs/faststore/components/organisms/banner-text.mdx
@@ -1,14 +1,14 @@
 ---
-title: Banner Text
-excerpt: Banner Text is used for advertising brands, products, and/or collections. They comprise an image, some text content, and a call-to-action button.
+title: BannerText
+excerpt: Displays brands, products, and/or collections. They comprise an image, some text content, and a call-to-action button.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/Hero___c73fdfe80ce87c2ccc4701c07e9d5398.png
 components:
   - BannerText.tsx
   - BannerTextContent.tsx
 ---
 
-Banner Text is used for advertising brands, products, and/or collections. They comprise an image, some text content, and a call-to-action button.The final `BannerText` component is a compound of the following:
+The `BannerText` is used for advertising brands, products, and/or collections. They comprise an image, some text content, and a call-to-action button.The final `BannerText` component is a compound of the following:
 
 - `BannerText`: wraps the BannerText component.
 - `BannerTextContent`: the content of the banner, including a title, caption, and Link.
@@ -71,11 +71,11 @@ Follow the instructions in the [Importing FastStore UI component styles](https:/
 All banner text related components support all attributes also supported by the `<div>` tag.
 Besides those attributes, the following props are also supported:
 
-### Banner Text
+### BannerText
 
 <ComponentPropsSection component="BannerText" />
 
-### Banner Text Content
+### BannerTextContent
 
 <ComponentPropsSection component="BannerTextContent" />
 

diff --git a/docs/faststore/components/organisms/cart-sidebar.mdx b/docs/faststore/components/organisms/cart-sidebar.mdx
@@ -1,6 +1,6 @@
 ---
-title: "Cart Sidebar"
-excerpt: The `CartSidebar` displays the summary of items added to the cart along with detailed information, and checkout option.
+title: "CartSidebar"
+excerpt: Displays the summary of items added to the cart along with detailed information, and checkout option.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/CartSidebar___5863b0eb4a4a8ce9a98da5c760461e61.png
 components:
@@ -160,7 +160,7 @@ Follow the instructions in the [Importing FastStore UI component styles](https:/
 
 <SectionList grid="row">
   <SectionItem
-    title="Order Summary"
+    title="OrderSummary"
     description="This component provide a summary of the items in the cart, including the total price, related shipping tax, and discounts."
     actionPath="/docs/guides/faststore/molecules-order-summary"
     fullWidth

diff --git a/docs/faststore/components/organisms/empty-state.mdx b/docs/faststore/components/organisms/empty-state.mdx
@@ -1,13 +1,13 @@
 ---
-title: "Empty State"
-excerpt: This component can be used to represent an empty state.
+title: "EmptyState"
+excerpt: Represents the component's empty state while the main content is loading.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/PaymentMethods___b0f344b254360daa53406cd631887adf.png
 components:
   - EmptyState.tsx
 ---
 
-This component can be used to represent an empty state.
+The `EmptyState` can be used to represent an empty state.
 
 ## Overview
 

diff --git a/docs/faststore/components/organisms/filter-slider.mdx b/docs/faststore/components/organisms/filter-slider.mdx
@@ -178,7 +178,7 @@ Follow the instructions in the [Importing FastStore UI component styles](https:/
 
 ## Props
 
-### Filter Slider
+### FilterSlider
 
 <ComponentPropsSection component="FilterSlider" />
 

diff --git a/docs/faststore/components/organisms/filter.mdx b/docs/faststore/components/organisms/filter.mdx
@@ -1,6 +1,6 @@
 ---
 title: "Filter"
-excerpt: The Filter component is used to filter products inside the Product Listing Page (PLP) and Search Page.
+excerpt: Filters products inside the Product Listing Page (PLP) and Search Page.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/PaymentMethods___b0f344b254360daa53406cd631887adf.png
 components:
@@ -10,7 +10,7 @@ components:
   - FilterFacetRange.tsx
 ---
 
-The Filter component is used to filter products inside the <a href="https://starter.vtex.app/office" target="_blank">Product Listing Page (PLP)</a> and Search Page. The `Filter` component is a compound of the following:
+The `Filter` component is used to filter products inside the <a href="https://starter.vtex.app/office" target="_blank">Product Listing Page (PLP)</a> and Search Page. The `Filter` component is a compound of the following:
 
 - `Filter`: wraps an `Accordion` along with the component title.
 - `FilterSlider`: `SlideOver` that wraps the `Filter` for small screen dimensions.
@@ -270,15 +270,15 @@ Follow the instructions in the [Importing FastStore UI component styles](https:/
 
 <ComponentPropsSection component="Filter" />
 
-### Filter Facets
+### FilterFacets
 
 <ComponentPropsSection component="FilterFacets" />
 
-### Filter Facet Boolean Item
+### FilterFacetBooleanItem
 
 <ComponentPropsSection component="FilterFacetBooleanItem" />
 
-### Filter Facet Range
+### FilterFacetRange
 
 <ComponentPropsSection component="FilterFacetRange" />
 

diff --git a/docs/faststore/components/organisms/hero.mdx b/docs/faststore/components/organisms/hero.mdx
@@ -1,6 +1,6 @@
 ---
 title: "Hero"
-excerpt: Hero displays a full-width banner at the top of a webpage.
+excerpt: Displays a full-width banner at the top of a webpage.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/Hero___c73fdfe80ce87c2ccc4701c07e9d5398.png
 components:
@@ -88,11 +88,11 @@ Besides those attributes, the following props are also supported:
 
 <ComponentPropsSection component="Hero" />
 
-### Hero Image
+### HeroImage
 
 <ComponentPropsSection component="HeroImage" />
 
-### Hero Header
+### HeroHeader
 
 <ComponentPropsSection component="HeroHeader" />
 

diff --git a/docs/faststore/components/organisms/image-gallery.mdx b/docs/faststore/components/organisms/image-gallery.mdx
@@ -1,13 +1,13 @@
 ---
-title: "Image Gallery"
+title: "ImageGallery"
 excerpt: Used when you want to display a series of photos in a gallery on a post or page.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/Hero___c73fdfe80ce87c2ccc4701c07e9d5398.png
 components:
   - ImageGallery.tsx
   - ImageGallerySelector.tsx
 ---
-An `ImageGallery` is used when you want to display a series of photos in a gallery on a post or page.According to the quantity of `Image` to be displayed, the `ImageGallerySelector` will be displayed.
+The `ImageGallery` is used when you want to display a series of photos in a gallery on a post or page.According to the quantity of `Image` to be displayed, the `ImageGallerySelector` will be displayed.
 
 ---
 
@@ -77,11 +77,11 @@ const currentImage = imagesUsage[selectedImageIdx]
 
 ## Props
 
-### Image Gallery
+### ImageGallery
 
 <ComponentPropsSection component="ImageGallery" />
 
-### Image Gallery Selector
+### ImageGallerySelector
 
 <ComponentPropsSection component="ImageGallerySelector" />
 

diff --git a/docs/faststore/components/organisms/navbar-slider.mdx b/docs/faststore/components/organisms/navbar-slider.mdx
@@ -1,5 +1,5 @@
 ---
-title: "Navbar Slider"
+title: "NavbarSlider"
 excerpt: As part of the Navbar, this component it its mobile version used to list the navigation links.
 components:
   - NavbarSlider.tsx
@@ -85,19 +85,19 @@ Follow the instructions in the [Importing FastStore UI component styles](https:/
 
 ## Props
 
-### Navbar Slider
+### NavbarSlider
 
 <ComponentPropsSection component="NavbarSlider" />
 
-### Navbar Slider Header
+### NavbarSliderHeader
 
 <ComponentPropsSection component="NavbarSliderHeader" />
 
-### Navbar Slider Content
+### NavbarSliderContent
 
 <ComponentPropsSection component="NavbarSliderContent" />
 
-### Navbar Slider Footer
+### NavbarSliderFooter
 
 <ComponentPropsSection component="NavbarSliderFooter" />
 

diff --git a/docs/faststore/components/organisms/navbar.mdx b/docs/faststore/components/organisms/navbar.mdx
@@ -1,14 +1,14 @@
 ---
 title: "Navbar"
-excerpt: This component represents the page header and groups features like Search and Regionalization.
+excerpt: Represents the page header and groups features like Search and Regionalization.
 components:
   - Navbar.tsx
   - NavbarHeader.tsx
   - NavbarRow.tsx
   - NavbarButtons.tsx
 ---
 
-Represents the page header and groups some features like: `Search`, `Regionalization`, `SignIn`, `CartSidebar`. This component is part of the [Navigation](https://developers.vtex.com/docs/guides/faststore/feature-navigation) feature.
+The `Navbar` represents the page header and groups some features like: `Search`, `Regionalization`, `SignIn`, `CartSidebar`. This component is part of the [Navigation](https://developers.vtex.com/docs/guides/faststore/feature-navigation) feature.
 
 ## Import
 
@@ -99,15 +99,15 @@ The [NavbarLinks](https://developers.vtex.com/docs/guides/faststore/molecules-na
 
 <ComponentPropsSection component="Navbar" />
 
-### Navbar Header
+### NavbarHeader
 
 <ComponentPropsSection component="NavbarHeader" />
 
-### Navbar Row
+### NavbarRow
 
 <ComponentPropsSection component="NavbarRow" />
 
-### Navbar Buttons
+### NavbarButtons
 
 <ComponentPropsSection component="NavbarButtons" />
 

diff --git a/docs/faststore/components/organisms/newsletter.mdx b/docs/faststore/components/organisms/newsletter.mdx
@@ -12,7 +12,7 @@ components:
   - NewsletterForm.tsx
   - NewsletterHeader.tsx
 title: Newsletter
-excerpt: The Newsletter component is a section with at least one input text with an action allowing users to submit their input.
+excerpt: The `Newsletter` component is a section with at least one input text with an action allowing users to submit their input.
 ---
 
 ## Import

diff --git a/docs/faststore/components/organisms/out-of-stock.mdx b/docs/faststore/components/organisms/out-of-stock.mdx
@@ -1,13 +1,13 @@
 ---
-title: "Out of Stock"
-excerpt: This component is used to announce to users that the product is out of stock.
+title: "OutOfStock"
+excerpt: Displays to users that the product is out of stock.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/OutOfStock___5863b0eb4a4a8ce9a98da5c760461e61.png
 components:
   - OutOfStock.tsx
 ---
 
-This component is used to announce to users that the product is out of stock. It also asks for their contact to let they know when the product arrives.
+This `OutOfStock` component is used to announce to users that the product is out of stock. It also asks for their contact to let they know when the product arrives.
 
 ## Import
 

diff --git a/docs/faststore/components/organisms/overview.mdx b/docs/faststore/components/organisms/overview.mdx
@@ -20,7 +20,7 @@ hideTOC: true
     </BannerText>
   </CardItem>
   <CardItem
-    title="Cart Sidebar"
+    title="CartSidebar"
     description="Displays the summary of items added to the cart along with detailed information, and checkout option."
     actionPath="/docs/guides/faststore/organisms-cart-sidebar"
   >
@@ -29,7 +29,7 @@ hideTOC: true
     </UIProvider>
   </CardItem>
   <CardItem
-    title="Empty State"
+    title="EmptyState"
     description="Used to represent an empty state."
     actionPath="/docs/guides/faststore/organisms-empty-state"
     zoomOut
@@ -56,7 +56,7 @@ hideTOC: true
     </UIProvider>
   </CardItem>
   <CardItem
-    title="Filter Slider"
+    title="FilterSlider"
     description="The mobile `Filter` view that is rendered inside a `SlideOver` component."
     actionPath="/docs/guides/faststore/organisms-filter-slider"
   >
@@ -129,7 +129,7 @@ hideTOC: true
     actionPath="/docs/guides/faststore/organisms-out-of-stock"
   >
     <OutOfStock
-      title="Out of Stock"
+      title="OutofStock"
       subtitle="Notify me when available"
       inputLabel="Email"
       buttonLabel="Notify Me"
@@ -138,37 +138,37 @@ hideTOC: true
     />
   </CardItem>
   <CardItem
-    title="Payment Methods"
+    title="PaymentMethods"
     description="Displays the logos of the available payment options in a store."
     actionPath="/docs/guides/faststore/organisms-payment-methods"
   >
     <PaymentMethods title={<h3>Payment Methods</h3>} flagList={flags} />
   </CardItem>
   <CardItem
-    title="Price Range"
+    title="PriceRange"
     description="`Slider` that allows users to select a maximum and minimum price from a range."
     actionPath="/docs/guides/faststore/organisms-price-range"
   >
     <PriceRangeUsage />
   </CardItem>
   <CardItem
-    title="Product Grid"
+    title="ProductGrid"
     description="A section generally used on PLP pages to list the products available in the store."
     actionPath="/docs/guides/faststore/organisms-product-grid"
     zoomOut
   >
     <ProductGridUsage />
   </CardItem>
   <CardItem
-    title="Product Shelf"
+    title="ProductShelf"
     description="Displays a list of products to be used as a section on the store."
     actionPath="/docs/guides/faststore/organisms-product-shelf"
     zoomOut
   >
     <ProductShelfUsage items={6}/>
   </CardItem>
   <CardItem
-    title="Region Modal"
+    title="RegionModal"
     description="A `Modal` with some region configurations. The component is part of `Regionalization` feature."
     actionPath="/docs/guides/faststore/organisms-region-modal"
   >
@@ -177,21 +177,21 @@ hideTOC: true
     </UIProvider>
   </CardItem>
   <CardItem
-    title="Search Input"
+    title="SearchInput"
     description="Responsible to receive, search and display suggestions. This component is part of the `Search` feature."
     actionPath="/docs/guides/faststore/organisms-search-input"
   >
     <SearchInputUsage />
   </CardItem>
   <CardItem
-    title="Shipping Simulation"
+    title="ShippingSimulation"
     description="Lets customers set the `PostalCode` and see the shipping options in the `PDP`."
     actionPath="/docs/guides/faststore/organisms-shipping-simulation"
   >
     <ShippingSimulationUsage />
   </CardItem>
   <CardItem
-    title="Slide Over"
+    title="SlideOver"
     description="Represents an aditional session that complements the screen's information."
     actionPath="/docs/guides/faststore/organisms-slide-over"
   >

diff --git a/docs/faststore/components/organisms/payment-methods.mdx b/docs/faststore/components/organisms/payment-methods.mdx
@@ -1,13 +1,13 @@
 ---
 title: "PaymentMethods"
-excerpt: Payment Methods display the logos of the available payment options in a store.
+excerpt: Displays the logos of the available payment options in a store.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/PaymentMethods___b0f344b254360daa53406cd631887adf.png
 components:
   - PaymentMethods.tsx
 ---
 
-The PaymentMethods component displays the logos of the available payment options in a store.
+The `PaymentMethods` component displays the logos of the available payment options in a store.
 
 ## Import
 

diff --git a/docs/faststore/components/organisms/price-range.mdx b/docs/faststore/components/organisms/price-range.mdx
@@ -1,13 +1,13 @@
 ---
-title: "Price Range"
-excerpt: Price Ranges are sliders that allows users to select a maximum and minimum price.
+title: "PriceRange"
+excerpt: Sliders that allows users to select a maximum and minimum price.
 sidebar_custom_props:
   image: https://vtexhelp.vtexassets.com/assets/docs/src/PriceRange___5863b0eb4a4a8ce9a98da5c760461e61.png
 components:
   - PriceRange.tsx
 ---
 
-The Price Range component is a [Slider](https://developers.vtex.com/docs/guides/faststore/atoms-slider) that allows users to select a maximum and minimum price from a range.
+The `PriceRange` component is a [Slider](https://developers.vtex.com/docs/guides/faststore/atoms-slider) that allows users to select a maximum and minimum price from a range.
 
 ## Overview