Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/singleware/ui-fieldset
UI fieldset package.
https://github.com/singleware/ui-fieldset
browser fieldset javascript singleware typescript user-interface web-component
Last synced: 4 days ago
JSON representation
UI fieldset package.
- Host: GitHub
- URL: https://github.com/singleware/ui-fieldset
- Owner: Singleware
- License: mit
- Created: 2018-11-04T20:20:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-13T17:20:29.000Z (almost 5 years ago)
- Last Synced: 2024-04-24T14:29:22.832Z (7 months ago)
- Topics: browser, fieldset, javascript, singleware, typescript, user-interface, web-component
- Language: JavaScript
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UI-Fieldset
Custom HTML element used to mirror field properties in its first-level children.
### State Attributes
| Name | Description |
| ------- | ------------------------------------------------------------------------ |
| empty | Automatically assigned when all first-level children are empty |
| invalid | Automatically assigned when one or more first-level children are invalid |
### Mirrored Properties
| Name | Description |
| -------- | ------------------------------------------------------------------------------ |
| value | Get or set an object with the `name` and `value` from all first-level children |
| required | Get or set the `required` state into all first-level children |
| readOnly | Get or set the `readOnly` state into all first-level children |
| disabled | Get or set the `disabled` state into all first-level children |
### Properties
| Name | Description |
| ----------- | ------------------------------------------------------------------------------------------ |
| type | Get or set the fieldset type |
| name | Get or set the fieldset name |
| empty | Get the empty state based on all first-level children |
| unwind | Get or set the unwind state determining whether the value property must be unrolled or not |
| orientation | Get and set the fieldset orientation. Use: `row` or `column` value |
### Methods
| Name | Description |
| ------------- | ----------------------------------------------------------- |
| focus | Move the focus to the first-level child that can be focused |
| reset | Reset all first-level children to its initial values |
| checkValidity | Check whether all first-level children are valid or not |
### Events
| Name | Description |
| ------ | ----------------------------------------------------- |
| change | Dispatched when some field in the fieldset is changed |
## Install
Using npm:
```sh
npm i @singleware/ui-fieldset
```
## License
[MIT © Silas B. Domingos](https://balmante.eti.br)