rosid-handler-malvid
v4.0.0
Published
UI to help you build and document web components
Downloads
126
Maintainers
Readme
rosid-handler-malvid
UI to help you build and document web components.
Install
npm install rosid-handler-malvid
Usage
API
const handler = require('rosid-handler-malvid')
handler('.html').then(console.log) // Returns HTML of the UI
handler('.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-malvid
will return the HTML of the UI or the JSON for the UI depending on the path.
{
"name" : "Malvid",
"path" : "ui/index.{html,html.json}",
"handler" : "rosid-handler-malvid"
}
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 or JSON of the UI.