smarkform
v0.7.0
Published
[![SmarkForm Logo](docs/assets/SmarkForm_logo.png)](https://www.npmjs.com/package/smarkform)
Downloads
499
Maintainers
Readme
SmarkForm is a powerful library for creating markup-driven and extendable forms in web applications.
SmarkForm empowers designers to enhance their form templates with advanced capabilities, such as dynamic list manipulation and context-based interactions, with no need to deal with complex JavaScript code.
Features
- Responsive and accessible UX across devices.
- Imports/Exports JSON supporting nested subforms (objects) and variable-length lists (arrays).
- Configurable context-driven keyboard shortcuts (hotkeys).
- Easy to use Markup-driven and Intuitive API.
- No reliance on a specific HTML structure: Designers have complete freedom.
- No manual wiring between controls and fields.
- Lightweigh (Only {{ site.data.computed.bundleSizeKB }}KB minified), flexible and extendable.
- More...
Installation
As NPM package:
npm install smarkform
.Alternatively you can get SmarkForm through several other resources such as CDN and more...
Usage
For detailed usage instructions and API reference check out 📔 SmarkForm Reference Manual.
Try it yourself!!
See our Live Examples.
- You can download each one and modify as you like.
See also interactive code snippets across the Reference Manual.
- They show relevant HTML, JS (and sometimes CSS).
- Try them out in the Preview tab.
- Don't miss the Notes tabs for relevant insights.
Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
Before contributing, make sure to read our contribution guidelines.
Documentation
You can find official SmarkForm documentation at:
👉 https://smarkform.bitifet.net
Documentation Source:
Documentation source can be found in /docs directory of this repository.
It uses Jekyll and just-the-docs Jekyll layout and it is automatically deployed by GitHub infrastructure anytime new revision is pushed..
Documentation Building:
To build SmarkForm documentation localloy you first need to install follow this instructions:
Execute
gem install jekyll bundler
.Run
npm run doc
.
Then you will be able to see the documentation at http://localhost:4000
or
http://<your-ip>:4000
.
License
Acknowledgements
We would like to express our gratitude to the open source community for their valuable contributions and feedback.