diff --git a/packages/tabs-overflow/README.md b/packages/tabs-overflow/README.md index f3cdef6aca..c1d21c752c 100644 --- a/packages/tabs-overflow/README.md +++ b/packages/tabs-overflow/README.md @@ -1,6 +1,8 @@ ## Description -The `` is a decorator component for the `` component that enables scrolling for horizontal tabs when there is not enough width to display all of the tabs. +The `` is a decorative component that works in conjunction with the `` component. It enables horizontal tab scrolling in cases where the available width is insufficient to display all tabs. + +_Note: Veritical scrolling is not yet supported._ ### Usage @@ -11,13 +13,13 @@ The `` is a decorator component for the `` component yarn add @spectrum-web-components/tabs-overflow ``` -Import the side effectful registration of `` via: +To import the `` component with its associated side effects, use the following import statement: ``` import '@spectrum-web-components/tabs-overflow/sp-tabs-overflow.js'; ``` -When looking to leverage the `TabsOverflow` base class as a type and/or for extension purposes, do so via: +To utilize the `TabsOverflow` base class as a type or for extending its functionality, utilize the following method: ``` import { TabsOverflow } from '@spectrum-web-components/tabs-overflow'; @@ -25,7 +27,7 @@ import { TabsOverflow } from '@spectrum-web-components/tabs-overflow'; ## Example -To use the `` component, simply wrap it around the `` element as a child element, like so: +To use the `` component, simply wrap it around the `` element as a child element: ```html