Options
All
  • Public
  • Public/Protected
  • All
Menu

Framework @swim/ux

@swim/ux

package documentation chat

@swim/ux implements a user interface toolkit for advanced real-time applications. @swim/ux provides popovers, drawers, menus, toolbars, controls, and other interactive application views and controllers. @swim/ux is a part of the broader @swim/toolkit framework.

Framework

The @swim/ux umbrella package depends on, and re-exports, the following component libraries:

@swim/ux builds on the @swim/core and @swim/ui frameworks; it has no additional required dependencies.

Installation

npm

For an npm-managed project, npm install @swim/ux to make it a dependency. TypeScript sources will be installed into node_modules/@swim/ux/main. Transpiled JavaScript and TypeScript definition files install into node_modules/@swim/ux/lib/main. And a pre-built UMD script, which bundles all @swim/ux component libraries, can be found in node_modules/@swim/ux/dist/main/swim-ux.js.

Browser

Browser applications can load swim-ux.js, along with its swim-core.js and swim-ui.js dependencies, from the SwimOS CDN.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ux.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ux.min.js"></script>

Alternatively, the swim-toolkit.js script may be loaded, along with its swim-system.js dependency, from the SwimOS CDN. The swim-toolkit.js script bundles @swim/ux together with all other @swim/toolkit frameworks.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.min.js"></script>

Usage

ES6/TypeScript

@swim/ux can be imported as an ES6 module from TypeScript and other ES6-compatible environments. All component libraries are re-exported by the umbrella @swim/ux module.

import * as swim from "@swim/ux";

CommonJS

@swim/ux can also be used with CommonJS-compatible module systems. All component libraries are re-exported by the umbrella @swim/ux module.

var swim = require("@swim/ux");

Browser

When loaded by a web browser, the swim-ux.js script adds all component library exports to the global swim namespace. The swim-ux.js script requires that swim-core.js and swim-ui.js have already been loaded.

The swim-toolkit.js script also adds all @swim/ux component library exports to the global swim namespace, making it a drop-in replacement for swim-ui.js and swim-ux.js when additional @swim/toolkit frameworks are needed.

Index

References

References

AnyColLayout

Re-exports AnyColLayout

AnyDeckPost

Re-exports AnyDeckPost

AnyDeckRail

Re-exports AnyDeckRail

AnyTableLayout

Re-exports AnyTableLayout

AnyTreeCell

Re-exports AnyTreeCell

AnyTreeLeaf

Re-exports AnyTreeLeaf

AnyTreeLimb

Re-exports AnyTreeLimb

AnyTreeRoot

Re-exports AnyTreeRoot

AnyTreeSeed

Re-exports AnyTreeSeed

AnyTreeStem

Re-exports AnyTreeStem

AnyTreeVein

Re-exports AnyTreeVein

AnyTreeView

Re-exports AnyTreeView

ButtonGlow

Re-exports ButtonGlow

ButtonGlowState

Re-exports ButtonGlowState

ButtonItem

Re-exports ButtonItem

ButtonMembrane

Re-exports ButtonMembrane

ButtonMembraneInit

Re-exports ButtonMembraneInit

ButtonObserver

Re-exports ButtonObserver

ButtonStack

Re-exports ButtonStack

ButtonStackController

Re-exports ButtonStackController

ButtonStackObserver

Re-exports ButtonStackObserver

ButtonStackState

Re-exports ButtonStackState

CellComponent

Re-exports CellComponent

CellComponentObserver

Re-exports CellComponentObserver

CellContent

Re-exports CellContent

CellContentFunction

Re-exports CellContentFunction

CellTrait

Re-exports CellTrait

CellTraitObserver

Re-exports CellTraitObserver

CellView

Re-exports CellView

CellViewObserver

Re-exports CellViewObserver

ColComponent

Re-exports ColComponent

ColComponentObserver

Re-exports ColComponentObserver

ColHeader

Re-exports ColHeader

ColHeaderFunction

Re-exports ColHeaderFunction

ColLayout

Re-exports ColLayout

ColLayoutInit

Re-exports ColLayoutInit

ColTrait

Re-exports ColTrait

ColTraitObserver

Re-exports ColTraitObserver

ColView

Re-exports ColView

ColViewObserver

Re-exports ColViewObserver

DeckBar

Re-exports DeckBar

DeckBarObserver

Re-exports DeckBarObserver

DeckButton

Re-exports DeckButton

DeckButtonObserver

Re-exports DeckButtonObserver

DeckCard

Re-exports DeckCard

DeckPost

Re-exports DeckPost

DeckPostInit

Re-exports DeckPostInit

DeckRail

Re-exports DeckRail

DeckRailInit

Re-exports DeckRailInit

DeckSlider

Re-exports DeckSlider

DeckSliderObserver

Re-exports DeckSliderObserver

DeckSlot

Re-exports DeckSlot

DeckView

Re-exports DeckView

DeckViewController

Re-exports DeckViewController

DeckViewObserver

Re-exports DeckViewObserver

DisclosureButton

Re-exports DisclosureButton

DisclosureTreeCell

Re-exports DisclosureTreeCell

DrawerButton

Re-exports DrawerButton

DrawerPlacement

Re-exports DrawerPlacement

DrawerState

Re-exports DrawerState

DrawerView

Re-exports DrawerView

DrawerViewController

Re-exports DrawerViewController

DrawerViewObserver

Re-exports DrawerViewObserver

FloatingButton

Re-exports FloatingButton

FloatingButtonType

Re-exports FloatingButtonType

IconButton

Re-exports IconButton

IconTreeCell

Re-exports IconTreeCell

IconTreeCellInit

Re-exports IconTreeCellInit

InputTokenView

Re-exports InputTokenView

InputTokenViewController

Re-exports InputTokenViewController

InputTokenViewInit

Re-exports InputTokenViewInit

InputTokenViewObserver

Re-exports InputTokenViewObserver

ListItem

Re-exports ListItem

ListItemController

Re-exports ListItemController

ListItemObserver

Re-exports ListItemObserver

ListView

Re-exports ListView

ListViewController

Re-exports ListViewController

ListViewObserver

Re-exports ListViewObserver

PopoverPlacement

Re-exports PopoverPlacement

PopoverView

Re-exports PopoverView

PopoverViewController

Re-exports PopoverViewController

PopoverViewInit

Re-exports PopoverViewInit

PopoverViewObserver

Re-exports PopoverViewObserver

RowComponent

Re-exports RowComponent

RowComponentObserver

Re-exports RowComponentObserver

RowTrait

Re-exports RowTrait

RowTraitObserver

Re-exports RowTraitObserver

RowView

Re-exports RowView

RowViewObserver

Re-exports RowViewObserver

ScrimView

Re-exports ScrimView

TableComponent

Re-exports TableComponent

TableComponentObserver

Re-exports TableComponentObserver

TableLayout

Re-exports TableLayout

TableLayoutInit

Re-exports TableLayoutInit

TableTrait

Re-exports TableTrait

TableTraitObserver

Re-exports TableTraitObserver

TableView

Re-exports TableView

TableViewObserver

Re-exports TableViewObserver

TitleDeckBar

Re-exports TitleDeckBar

TitleDeckViewController

Re-exports TitleDeckViewController

TitleTreeCell

Re-exports TitleTreeCell

TokenView

Re-exports TokenView

TokenViewController

Re-exports TokenViewController

TokenViewInit

Re-exports TokenViewInit

TokenViewObserver

Re-exports TokenViewObserver

TokenViewState

Re-exports TokenViewState

TreeCell

Re-exports TreeCell

TreeCellController

Re-exports TreeCellController

TreeCellInit

Re-exports TreeCellInit

TreeCellObserver

Re-exports TreeCellObserver

TreeLeaf

Re-exports TreeLeaf

TreeLeafController

Re-exports TreeLeafController

TreeLeafInit

Re-exports TreeLeafInit

TreeLeafObserver

Re-exports TreeLeafObserver

TreeLimb

Re-exports TreeLimb

TreeLimbController

Re-exports TreeLimbController

TreeLimbInit

Re-exports TreeLimbInit

TreeLimbObserver

Re-exports TreeLimbObserver

TreeLimbState

Re-exports TreeLimbState

TreeRoot

Re-exports TreeRoot

TreeRootInit

Re-exports TreeRootInit

TreeSeed

Re-exports TreeSeed

TreeSeedInit

Re-exports TreeSeedInit

TreeStem

Re-exports TreeStem

TreeStemController

Re-exports TreeStemController

TreeStemInit

Re-exports TreeStemInit

TreeStemObserver

Re-exports TreeStemObserver

TreeVein

Re-exports TreeVein

TreeVeinController

Re-exports TreeVeinController

TreeVeinInit

Re-exports TreeVeinInit

TreeVeinObserver

Re-exports TreeVeinObserver

TreeView

Re-exports TreeView

TreeViewContext

Re-exports TreeViewContext

TreeViewController

Re-exports TreeViewController

TreeViewInit

Re-exports TreeViewInit

TreeViewObserver

Re-exports TreeViewObserver

Generated using TypeDoc