node package manager

rosid-handler-components

rosid-handler-components

Travis Build Status AppVeyor Status Coverage Status Dependencies

UI to help you build and document web components.

Install

npm install rosid-handler-components

Usage

API

const components = require('rosid-handler-components')
 
components('.html').then(console.log) // Returns HTML of the UI 
components('.json').then(console.log) // Returns JSON for the UI 

Rosid

Add the following object to your rosidfile.json, rosidfile.js or routes array. rosid-handler-components will return the HTML of the UI or the JSON for the UI depending on the path.

{
    "name"    : "Components",
    "path"    : "ui/**/index.{html,html.json}",
    "handler" : "rosid-handler-components"
}

Disable automatic page reloads for the UI to get realtime updates when developing components. You can do so by using the --static or -s option in the CLI or by using the static option.

rosid serve src/ dist/ -s '/ui/index.html'
Rosid.serve('src/', { static: '/ui/index.html' }, (err) => {})

Parameters

  • filePath {?*} Fictive path that ends with .html or .json
  • opts {?Object} Options.

Returns

  • {Promise}({String|Buffer}) HTML of the UI.