1.0.0 • Published 4 years ago

@cxxi/xcomponent v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

xComponent.js

Light HTML Custom Elements creation with lifecycle, renderEngine and eventManager.

Table of Contents

  1. Documentation
    1. Installation
    2. Examples
    3. Methods
    4. Objects
  2. Known issues
  3. Contributing
  4. License

Goal and Philosophy

xComponent.js xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Node.js xxxxxxxxxxxxxxxxxxxxxxxx

xComponent.js xxxxxxxxxxxx

  • xxxxx xxxxxxx
  • xxx xxxx
  • xxxxxx xxxxx
  • xxxxx xxxxxx
  • xxxxxxx xxxxxx xxxxxx

Note: xComponent.js provides xxxxxxx xxxxxxxxxxxx xxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxx xxxxxxxx xxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxx xxxxxxxxxxxxxx xxxxxxxxxxxxxx xxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxx xxxxxxx.

Documentation

Installation

npm install xcomponent
import xComponent from 'xComponent'

Examples (Run it and see it)

Check out ...

Methods

init(localScope)

Launch the prompt interface (inquiry session)

  • questions (Array) containing Question Object (using the reactive interface, you can also pass a Rx.Observable instance)
  • answers (object) contains values of already answered questions. Inquirer will avoid asking answers already provided here. Defaults {}.
  • returns a Promise

render(x)

Register prompt plugins under name.

  • name (string) name of the this new prompt. (used for question type)
  • prompt (object) the prompt object itself (the plugin)

behavior(Event)

Create a self contained inquirer module. If you don't want to affect other libraries that also rely on inquirer when you overwrite or add new prompt types.

var prompt = inquirer.createPromptModule();

prompt(questions).then(/* ... */);

Objects

Event

Known issues

...

Contributing

Unit test Unit test are written in Mocha. Please add a unit test for every new feature or bug fix. npm test to run the test suite.

Documentation Add documentation for every API change. Feel free to send typo fixes and better docs!

License

Copyright (c) 2021 Louis-Antoine Lumet (twitter: @Mudryy_121) Licensed under the MIT license.