Miss any of our Open RFC calls?Watch the recordings here! »

This package has been deprecated

Author message:

UNMAINTAINED This Project Is No Longer Maintained

potamus-js

0.0.2 • Public • Published

potamus-stylus

Scripts for potamus components.

$ npm install --save-dev potamus-js

Until now, there the following components:

  • button
  • checkbox
  • radio
  • text-field

Usage

Use some module loader as webpack or rollup.

CommonJs:

const potamus = require('potamus-js');

ES6 Module

import potamus from 'potamus-js';

Components

All components works just fine without javascript, but with some limitations, so is good include this scripts.

Button

<button class="some-awesome-button-class-name">Button</button>
potamus.button('some-awesome-button-class-name', 'name-for-ripple-effect-class');

Checkbox

<input class="some-awesome-checkbox-class-name" type="checkbox">
potamus.checkbox('some-awesome-checkbox-class-name');

Radio

<input class="some-awesome-radio-name" type="radio" id="first" name="radio">
<input class="some-awesome-radio-name" type="radio" id="second" name="radio">

This component doesn't need javascript.

Text-field

<div class="some-awesome-text-field-name">
  <input class="some-awesome-text-field-name_sufix-input" type="text">
  <label class="some-awesome-text-field-name__sufix-label">Nome</label>
</div>
potamus.textField('some-awesome-text-field-name', '__sufix-label', '_sufix-input');

Contributing

  • Fork it!
  • Create a new branch for the new feature: git checkout -b my-new-feature
  • Commit your changes: git commit -m 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request with full remarks documenting your changes ;)

License

potamus is released under the terms of the MIT License

Install

npm i potamus-js

DownloadsWeekly Downloads

1

Version

0.0.2

License

MIT

Last publish

Collaborators

  • avatar