elite-forms
v0.1.1
Published
"Provides customizable web component for forms/input fields with built in validation using LitElements"
Keywords
Readme
EliteForms
EliteForms is a front end form library built from litElement web components with built-in data validation. Elite forms is lightweight, highly customizable, and extensible.
Installation
INSTALLATION INSTRUCTIONS ARE FOR BETA/DEV TESTING ONLY
Clone this repository to a folder where you keep all your software projects. i.e /Users/myUserName/Documents/CodeSmith/EliteForms
In the terminal navigate to the EliteForms directory you used cloned.
In the EliteForms directory run: npm link
Navigate to the project directory where you would like to test & use EliteForms.
In the test project directory run: npm link elite-forms
Usage
For .jsx files, or usage within React components
import 'elite-forms';
const App = props => {
return (
<elite-form>
type='email'
label='Email:'
placeholder='email'
id='email'
validationRules = {{
required: true,
email: true,
}}
</elite-form>
)
}For usage within vanilla HTML
<script type="module" src='../node_modules/elite-forms'></script>
<body>
<elite-form
type='email'
label='Email:'
placeholder='email'
id='email'
validationRules = {{
required: true,
email: true,
}}
></elite-form>
</body>Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
https://github.com/oslabs-beta/EliteForms
