JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q32716F
  • License Apache-2.0

Polyfea Material Shell Web Component

Package Exports

  • @polyfea/md-shell
  • @polyfea/md-shell/dist/index.cjs.js
  • @polyfea/md-shell/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@polyfea/md-shell) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Polyfea Material Application Shell

Web components for the application shell for Polyfea ecosystem, based on the Material Design scheme. It provides basic layout and context areas for the application composed of the microfrontends. In default configuration it contains top application bar, navigation rail or navigation drawer, top bar menu, main content area, and navigation bar on small resolution devices.

See documentation of the primary web component polyfea-md-shell for more details.

Installation

As npm module:

npm install @polyfea/md-shell

Deployment to the kubernetes cluster running polyfea controller:

kubectl apply -k https://github.com/polyfea/md-shell/raw/v1.0./deploy/manifests

Usage

See documentation of the primary web component polyfea-md-shell for more details

Documentation

These custom elements are provided by the package:

Element name Description
polyfea-md-shell The application shell for Polyfea ecosystem, based on the Material Design scheme. It provides basic layout and context areas for the application composed of the microfrontends. In default configuration it contains top application bar, navigation rail or navigation drawer, top bar menu, main content area, and navigation bar on small resolution devices.
polyfea-md-app The application link for the polyfea ecosystem. Renders according to context in which it is used - as card tile, navigation drawer link, navigation rail action, or navigation bar action
polyfea-md-apps The list of application tiles for the polyfea ecosystem. Intended as the main content element for landing zone page
polyfea-md-topbar The top application bar for the polyfea md shell. It contains the application leading icon, title, trailing icons, and menu button.
polyfea-md-drawer The navigation drawer for the polyfea md shell. It contains the list of application links.
polyfea-md-drawer-label The navigation drawer label to separate or group drawer actions
polyfea-md-rail The navigation rail for the polyfea md shell. It contains the list of application actions.
polyfea-md-navigation The navigation bar for the polyfea md shell. It contains the list of application links.
polyfea-md-theme-control The theme control buttons/menu items to control font and theme mode