Premium DOM Component

Dockable Panels

Expand, collapse, dock and float

by Read Write Tools
Abstract
The rwt-dockable-panels DOM component is an accordion-style component with panels that expand/collapse and dock/float.

Motivation

Some apps have lots of interactive manipulations for working with a canvas or object. Putting the tools and options for these manipulation commands within menus is a weak design pattern. The use of floatable, dockable, and collapsable panels is a better alternative because it lets the user initiate commands with shorter mouse transit times and fewer clicks. It also provides the user with a personalized mental map of where the commands can be initiated, something that a hierarchical menu doesn't do well.

The component has these features:

  • The component comprises a collection of panels that contain logically related information.
  • Each panel has a titlebar for self-identification and a panel area comprising DOM elements.
  • The titlebar has an expand/collapse button which allows the panel's elements to be shown or hidden.
  • The titlebar has a float/dock button which allows the panel to be detached/attached from the main panel.
  • Floating panels can be moved with the mouse by dragging the titlebar.
  • The initial position of the menu is relative to any one of the four viewport corners.

In the wild

To see an example of this component in use, visit the simply.earth website. It uses this component for its Tangent, Scale, Rotate, Locate, and Identify panels. 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-dockable-panels DOM component works in any browser that supports modern W3C standards. Templates are written using BLUEPHRASE 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-dockable-panels

OPTION 2: No prior experience using NPM?
Just follow these general steps:

  • Install Node.js/NPM on your development computer.
  • 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-dockable-panels

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-dockable-panels DOM component into it using the command:
  • git clone https://github.com/readwritetools/rwt-dockable-panels.git

Using the DOM component

After installation, you need to add two things to your HTML page to make use of it:

  1. Add a script tag to load the component's rwt-dockable-panels.js file:
  2. <script src='/node_modules/rwt-dockable-panels/rwt-dockable-panels.js' type=module></script>             
  3. Add the component tag somewhere on the page.
    • For scripting purposes, apply an id attribute.
    • For WAI-ARIA accessibility apply a role=contentinfo attribute.
    • Apply a corner attribute with one of these values
      • top-left
      • top-right
      • bottom-left
      • bottom-right
    • Apply a sourceref attribute with a reference to a JSON file containing the panel configuration. (Or optionally use the programmatic interface for panel configuration.)
    • Optionally, apply an open or closed attribute to set the initial state of the toolbar
    <rwt-dockable-panels id=toolbarId sourceref='/panels.json' corner=top-right role=contentinfo open></rwt-dockable-panels>

Panel configuration

The panels can be configured programmatically or through a JSON file. Both accept similar objects.

JSON file configuration

A JSON file containing a collection of panel configurations can be specified as an attribute of the component. Do this with HTML like <rwt-dockable-panels sourceref='panels.json'></rwt-dockable-panels> The JSON object should contain an object with two properties:

  1. toolbar an object for configuring the entire component, having:
    • titlebar the plain text or HTML to use for the main menu.
  2. panels an array of panel objects for configuring the panels, having:
    • options an object to configure each panel's basic properties;
      • id the HTML identifier for the panel
      • titlebar the text title for the panel
      • tabIndex the HTML tabIndex, optional
      • tooltip the fly-over popup title for the panel, optional
    • panelLines an array of line objects to configure the elements of the panel, line by line.
      • lineType specifies what to put on the line, see below
      • id the HTML identifier for the line's principal element, see below

These are the possible lineTypes and their configuration properties:

  1. "input"
    • labelText the text to place before the INPUT element
    • id the identifier for the INPUT element
    • textAfter any text to place after the INPUT element, optional
    • tooltip the fly-over popup title for the INPUT element, optional
  2. "dropdown"
    • labelText the text to place before the SELECT element
    • id the identifier for the SELECT element
    • tooltip the fly-over popup title for the SELECT element, optional
    • selections an array of OPTIONS, specified as objects, each having:
      • v the OPTION value
      • t the OPTION text
  3. "button"
    • buttonText the text to place on the BUTTON element
    • id the identifier for the BUTTON element
    • tooltip the fly-over popup title for the BUTTON element, optional
  4. "multi-button"
    • buttons an array of objects to define each button, having:
      • buttonText the text to place on the BUTTON element
      • id the identifier for the BUTTON element
      • tooltip the fly-over popup title for the BUTTON element, optional
  5. "generic"
    • id the identifier for the DIV element
    • heightInPx the height of the DIV element, specified with "px"
    • overflowY Whether to show the scrollbar, either "scroll" or "hidden"

Programmatic configuration

The component has methods to programmatically configure panels. They use objects with the same properties as just described. The methods are:

setTitlebar (html)
sets the topmost menu titlebar
appendPanel (panelId, options, panelLines)
creates a new panel and adds it to the component
appendInputLine (elPanel, options)
creates a line with a label and an input
appendDropdown (elPanel, options)
creates a line with a label and a select element
appendSingleButton (elPanel, options)
creates an internal button for doing something user-defined
appendMultiButtons (elPanel, options)
creates multiple buttons that logically work together and visually appear on one line
appendGenericArea (elPanel, options)
creates a div suitable for use with dynamic HTML

Programmatic manipulation

The component also has methods to programmatically manipulate the toolbar and its panels.

openToolbar ()
shows all the panels in their current expand/collapse state
closeToolbar ()
leaves only the Star button visible
expandPanel (menuID)
shows all of the panel's lines
collapsePanel (menuID)
shows only the panel's titlebar
detachPanel (menuID)
detaches the panel from the toolbar, allowing it to float independently
attachPanel (menuID)
reattaches the panel to the toolbar

Customization

Initial position

Initially the toolbar is positioned a certain distance from one of the viewport's corners, specified using the corner attribute and two of these offset variables.

rwt-dockable-panels {
--top: 30px;
--bottom: 30px;
--left: 30px;
--right: 30px;
--z-index: 1;
}

Visuals and color scheme

The font for the component can be changed with the --font-family variable.

The width of the component can be set with the --width variable.

The default color palette for the menu uses a dark mode theme. You can use CSS to override the variables' defaults:

rwt-dockable-panels {
--color: var(--pure-white);
--border-color: var(--pure-white);
--background-color1: var(--surfie-green);
--background-color2: var(--coral-atoll);
--background-color3: var(--tiber);
--background-color4: var(--eden);
}

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.

Reference

DOM components logo Documentation READ WRITE HUB
git logo Source code github
DOM components logo Component catalog DOM COMPONENTS
npm logo Package installation npm
Read Write Stack logo Publication venue READ WRITE STACK

License

The rwt-dockable-panels 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.

Dockable Panels Software License Agreement
  1. This Software License Agreement ("Agreement") is a legal contract between you and Read Write Tools ("RWT"). The "Materials" subject to this Agreement include the "Dockable Panels" software and associated documentation.
  2. By using these Materials, you agree to abide by the terms and conditions of this Agreement.
  3. 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.
  4. 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.
  5. 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.
  6. 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.
  7. 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.
  8. 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.
  9. 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.
  10. 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.
  11. 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:

export default [{
"product-key": "rwt-dockable-panels",
"registration": "example.com",
"customer-number": "CN-xxx-yyyyy",
"access-key": "AK-xxx-yyyyy"
}]

Dockable Panels — Expand, collapse, dock and float

🔗 🔎