README.md

atex/types

This directory contains the following declaration files:

• index.d.ts: Basic JSX types.
• modules.d.ts: Declarations to support .jsonc imports.
• all.d.ts: A complete list of types for each VTEX App:

"types": [ "@eramis/atex/types/all" ]

Same as above but separated by Apps, if you're not using one in particular and don't want its types to appear in your IDE:

"types": [
  "@eramis/atex/types",
  // "@eramis/atex/types/vtex.add-to-cart-button",
  // "@eramis/atex/types/vtex.breadcrumb",
  // "@eramis/atex/types/vtex.category-menu",
  // "@eramis/atex/types/vtex.checkout-summary",
  // "@eramis/atex/types/vtex.condition-layout",
  // "@eramis/atex/types/vtex.disclosure-layout",
  // "@eramis/atex/types/vtex.flex-layout",
  // "@eramis/atex/types/vtex.iframe",
  // "@eramis/atex/types/vtex.login",
  // "@eramis/atex/types/vtex.menu",
  // "@eramis/atex/types/vtex.minicart",
  // "@eramis/atex/types/vtex.modal-layout",
  // "@eramis/atex/types/vtex.order-placed",
  // "@eramis/atex/types/vtex.overlay-layout",
  // "@eramis/atex/types/vtex.product-availability",
  // "@eramis/atex/types/vtex.product-comparison",
  // "@eramis/atex/types/vtex.product-customizer",
  // "@eramis/atex/types/vtex.product-gifts",
  // "@eramis/atex/types/vtex.product-highlights",
  // "@eramis/atex/types/vtex.product-list",
  // "@eramis/atex/types/vtex.product-price",
  // "@eramis/atex/types/vtex.product-quantity",
  // "@eramis/atex/types/vtex.product-specifications",
  // "@eramis/atex/types/vtex.product-summary",
  // "@eramis/atex/types/vtex.responsive-layout",
  // "@eramis/atex/types/vtex.rich-text",
  // "@eramis/atex/types/vtex.sandbox",
  // "@eramis/atex/types/vtex.search",
  // "@eramis/atex/types/vtex.search-result",
  // "@eramis/atex/types/vtex.seller-selector",
  // "@eramis/atex/types/vtex.similar-products-variants",
  // "@eramis/atex/types/vtex.slider-layout",
  // "@eramis/atex/types/vtex.stack-layout",
  // "@eramis/atex/types/vtex.sticky-layout",
  // "@eramis/atex/types/vtex.store-components",
  // "@eramis/atex/types/vtex.store-drawer",
  // "@eramis/atex/types/vtex.store-footer",
  // "@eramis/atex/types/vtex.store-form",
  // "@eramis/atex/types/vtex.store-header",
  // "@eramis/atex/types/vtex.store-link",
  // "@eramis/atex/types/vtex.store-locator",
  // "@eramis/atex/types/vtex.store-media",
  // "@eramis/atex/types/vtex.store-newsletter",
  // "@eramis/atex/types/vtex.store-video",
  // "@eramis/atex/types/vtex.tab-layout",
]

Basic components

• Add To Cart Button
• Search
• Breadcrumb
• Store Footer
• Store Header
• Login
• Menu (Incomplete due to the official VTEX documentation)
• Minicart (Incomplete due to the official VTEX documentation)
• Summary (Incomplete due to the official VTEX documentation)
• Order Placed
• Product Customizer
• Product Highlights
• Product List
• Product Price
• Product Quantity
• Product Specifications
• Product Summary (Except for list-context.product-list)
• Rich Text
• Search Result
• Store Image (Unable to write types for list-context.image-list)

Store components

• Autocomplete Result List (Deprecated in favor of autocomplete-result-list.v2)
• Back To Top Button
• Image
• Info Card
• Logo
• Notification
• Product Brand
• Product Description
• Product Images
• Product Name
• Product SKU Attributes
• Search Bar
• Share
• Shipping Simulator
• SKU Selector

Advanced components

• Category Menu
• Iframe
• Product Availability
• Product Comparison (Except for all list-context and product-summary blocks)
• Product Gifts
• Seller Selector
• Similar Products Variants
• Store Drawer
• Store Locator
• Store Form
• Store Link
• Store Media (Except for list-context.media-list)
• Store Newsletter
• Store Video
• Sandbox

Layout Apps

• Condition Layout
• Disclosure Layout
• Flex Layout
• Modal Layout
• Overlay Layout
• Responsive Layout
• Slider Layout
• Stack Layout
• Sticky Layout
• Tab Layout