The rwt-file-tabs DOM component is a thin bar containing named file tabs. It is typically used with apps that allow multiple files to be worked on simultaneously.
### Motivation
The rwt-file-tabs DOM component can be used in scenarios
with multiple views or multiple work tasks.
This component can be configured with a fixed set of tabs which are slotted into
the component when designing the document. Alternatively, its programming API
allows tabs to be created and removed as needed, when working with a dynamic set
of tabs.
Tabs can be configured using CSS to adjust their size and typography.
The tab bar occupies a fixed width. When the size of all tabs exceeds that
width, scroll buttons are automatically enabled.
Dynamic tabs can be closable or not, based on an attribute set on
the DOM component by the developer.
#### In the wild
To see an example of this component in use, visit the BLUEFIDDLE
website. It uses two components: one vertical and one horizontal. To understand
what's going on under the hood, use the browser's inspector to view the HTML
source code and network activity, and follow along as you read this
documentation.
### Installation
#### Prerequisites
The rwt-file-tabs DOM component works in any browser that
supports modern W3C standards. Templates are written using BLUE
PHRASE notation, which can be compiled into HTML using the free Read Write View
desktop app. It has no other prerequisites. Distribution and installation are
done with either NPM or via Github.
#### Download
Download using NPM
OPTION 1: Familiar with Node.js and the package.json file? Great. Install the component with this command:
npm install rwt-file-tabs
OPTION 2: No prior experience using NPM? Just follow these general steps:
Create a package.json file in the root of your web project using the command:
npm init
Download and install the DOM component using the command:
npm install rwt-file-tabs
Important note: This DOM component uses Node.js and NPM and package.json as a convenient distribution and installation mechanism. The DOM component itself does not need them.
Download using Github
If you prefer using Github directly, simply follow these steps:
Create a node_modules directory in the root of your web project.
Clone the rwt-file-tabs DOM component into it using the command:
### Using the DOM component
After installation, you need to add a few things to your HTML page to make use
of it.
* Add a `script` tag to load the component's `rwt-file-tabs.js` file:
```html
```
* Add the component tag somewhere on the page, configuring it with these optional
attributes:
* `closable` This optional attribute instructs the component to add an 'x' button to
each dynamically added tab, allowing the user to remove the tab.
* `scroll-side={left|right}` When the space occupied by the tabs is too large,
scroll buttons are enabled. They can be positioned to the `left` or the `right` of
the tabs.
* `anchor-side={left|right}` When the space occupied by the tabs is less than the
width of the component, the unoccupied space can be anchored to the `left` or to
the `right` of the tabs.
* `role=navigation` This web accessible ARIA attribute tells readers that the
component is used for navigation.
### Slotted usage
If the component is to be used with a predetermined set of tabs, they can be
slotted in. Here's an example:
```html
```
### Programmatic API
If the component is to be used with a dynamic set of tabs, they can be added and
removed using these methods.
insertTab(id, value, title)
The id should be a unique identifier. It will be used for manipulating the tab.
The value is the text to display on the tab. Text that is too long will be ellipsed.
The title parameter is optional, and if provided will be used as the hover tooltip.
removeTab(id)
The id is the identifier of the tab to remove.
getCurrentTab()
Returns an object with two values: currentTabId and currentTabValue.
setCurrentTab(id)
Changes the current tab to be the one identified with id.
getScrollableOverflow()
The size, in pixels, of the tabs that are hidden when the component isn't wide enough for all of them.
setScrollPosition(left)
The left parameter is the number of pixels to programmatically scroll the tabs. It should be an integer from 0 to scrollableOverflow.
scrollMaxRight()
Scroll the tabs all the way to the right. This is only meaningful when there is scrollable overflow.
### Life-cycle events
The component issues life-cycle events.
component-loaded
Sent when the component is fully loaded and ready to be used. As a convenience you can use the waitOnLoading() method which returns a promise that resolves when the component-loaded event is received. Call this asynchronously with await.
tab-activated
Sent when the user switches to a new tab. The event argument has a detail property containing the currentTabId and currentTabValue of the newly activated tab.
tab-closing
Sent when the user clicks on the 'x' to close a tab. This event allows the developer to determine if it's safe to close the tab. Use preventDefault() to cancel the operation. The event argument has a detail property containing the currentTabId and currentTabValue of the item about to be closed.
### Styling
#### Tab styling
The component can be styled with these CSS variables:
```css
rwt-file-tabs {
--width: 100%;
--height: 2rem;
--nav-button-size: 1.6rem;
}
```
The tabs can be styled with these CSS variables:
```css
rwt-file-tabs {
--font-weight: normal;
--letter-spacing: 0px;
--text-align: left;
--min-width: 2rem;
--max-width: 6rem;
}
```
#### Dialog color scheme
The default color palette for the component uses a dark mode theme. You can use
CSS to override the variables' defaults:
```css
rwt-file-tabs {
--color: var(--white);
--accent-color1: var(--pure-white);
--background: var(--black);
--accent-background1: var(--pure-black);
--accent-background2: var(--nav-black);
--accent-background3: var(--medium-black);
--accent-background4: var(--gray);
}
```
### Vertically oriented tabs
The component can be oriented vertically by wrapping it in a positioned element
and using a CSS transform. Here's an example of how to do it:
#### HTML
```html
### License
The rwt-file-tabs DOM component is not freeware. After
evaluating it and before using it in a public-facing website, eBook, mobile app,
or desktop application, you must obtain a license from Read Write Tools
.
File Tabs Software License Agreement
This Software License Agreement ("Agreement") is a legal contract between you and Read Write Tools ("RWT"). The "Materials" subject to this Agreement include the "File Tabs" software and associated documentation.
By using these Materials, you agree to abide by the terms and conditions of this Agreement.
The Materials are protected by United States copyright law, and international treaties on intellectual property rights. The Materials are licensed, not sold to you, and can only be used in accordance with the terms of this Agreement. RWT is and remains the owner of all titles, rights and interests in the Materials, and RWT reserves all rights not specifically granted under this Agreement.
Subject to the terms of this Agreement, RWT hereby grants to you a limited, non-exclusive license to use the Materials subject to the following conditions:
You may not distribute, publish, sub-license, sell, rent, or lease the Materials.
You may not decompile or reverse engineer any source code included in the software.
You may not modify or extend any source code included in the software.
Your license to use the software is limited to the purpose for which it was originally intended, and does not include permission to extract, link to, or use parts on a separate basis.
Each paid license allows use of the Materials under one "Fair Use Setting". Separate usage requires the purchase of a separate license. Fair Use Settings include, but are not limited to: eBooks, mobile apps, desktop applications and websites. The determination of a Fair Use Setting is made at the sole discretion of RWT. For example, and not by way of limitation, a Fair Use Setting may be one of these:
An eBook published under a single title and author.
A mobile app for distribution under a single app name.
A desktop application published under a single application name.
A website published under a single domain name. For this purpose, and by way of example, the domain names "alpha.example.com" and "beta.example.com" are considered to be separate websites.
A load-balanced collection of web servers, used to provide access to a single website under a single domain name.
THE MATERIALS ARE PROVIDED BY READ WRITE TOOLS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL READ WRITE TOOLS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This license is effective for a one year period from the date of purchase or until terminated by you or Read Write Tools. Continued use, publication, or distribution of the Materials after the one year period, under any of this Agreement's Fair Use Settings, is subject to the renewal of this license.
Products or services that you sell to third parties, during the valid license period of this Agreement and in compliance with the Fair Use Settings provision, may continue to be used by third parties after the effective period of your license.
If you decide not to renew this license, you must remove the software from any eBook, mobile app, desktop application, web page or other product or service where it is being used.
Without prejudice to any other rights, RWT may terminate your right to use the Materials if you fail to comply with the terms of this Agreement. In such event, you shall uninstall and delete all copies of the Materials.
This Agreement is governed by and interpreted in accordance with the laws of the State of California. If for any reason a court of competent jurisdiction finds any provision of the Agreement to be unenforceable, that provision will be enforced to the maximum extent possible to effectuate the intent of the parties and the remainder of the Agreement shall continue in full force and effect.
#### Activation
To activate your license, copy the `rwt-registration-keys.js` file to the *root
directory of your website*, providing the `customer-number` and `access-key` sent to
your email address, and replacing `example.com` with your website's hostname.
Follow this example:
by Read Write Tools
