Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fetchte/semantic-ui-redux-form-fields
Semantic UI Fields Integration with Redux From
https://github.com/fetchte/semantic-ui-redux-form-fields
react redux redux-form semantic-ui
Last synced: about 2 months ago
JSON representation
Semantic UI Fields Integration with Redux From
- Host: GitHub
- URL: https://github.com/fetchte/semantic-ui-redux-form-fields
- Owner: fetchTe
- License: other
- Created: 2017-09-29T05:58:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T09:49:41.000Z (about 2 years ago)
- Last Synced: 2024-11-06T23:17:56.480Z (about 2 months ago)
- Topics: react, redux, redux-form, semantic-ui
- Language: JavaScript
- Size: 2.21 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Semantic UI React Redux Form Fields
[](https://github.com/artisin/semantic-ui-redux-form-fields/blob/master/LICENSE.txt)
[](https://www.npmjs.com/package/semantic-ui-redux-form-fields)
[](https://app.wercker.com/project/byKey/318ec4f5595dcc395d305e27825e20bd)
[](https://github.com/artisin/semantic-ui-redux-form-fields/blob/master/package.json)
This React component library is designed to help you easily integrate [Semantic UI React](https://react.semantic-ui.com/introduction) with [Redux Form](http://redux-form.com). The components come all pre-hooked-up so you don't have to worry about error reporting or the presentation logic since everything works right out of the box. Included is the big five form components `Checkbox` `Dropdown`, `Input`, `Radio`, and `TextArea` as well as `fieldEnhance` a higher order component that gives you the flexibility to extend and customize.
## Install
__Package Manager__
```bash
# yarn
yarn add semantic-ui-redux-form-fields
# npm
npm install semantic-ui-redux-form-fields
```
__Github__
In the `dist/` directory contains a pre-build Node, Browser, and Browser minified version. However, I strongly recommend you use `yarn` or `npm`.
## Prerequisites
1. [Install and Config Redux](http://redux.js.org/)
2. [Install and Config Redux Form](redux-form.com/7.0.4/docs/gettingstarted.md/)
3. [Install and Config React Semantic UI](https://react.semantic-ui.com/usage)
+ The assumption is you are using Semantic UI. And while you can "technically" use these components as standalones it would not make much sense. Furthermore, the Semantic UI css styles are not included in this package to allow for easier style customizations with Semantic themes and such.
## Props
+ All the default Semantic UI props for each component can be passed just like you would expect.
+ `currentValue` → Is the `value` for all components. It's critically important that you use `currentValue` and not `value` otherwise the component will not work.
+ `topLabel` → A Semantic UI `label` that's positioned above the field (top-right).
+ Events → In all likelihood you'll need to implement custom events, and while you can use a non-append prop like `onChange` you won't have access to the redux-form `input` methods. However, by using these `{*}Custom` appended props `input` is passed as the first argument.
* `onBlurCustom(input, event, newValue, previousValue)`
* `onChangeCustom(input, event, newValue, previousValue)`
* `onDragStartCustom(input, event)`
* `onDropCustom(input, event, newValue, previousValue)`
* `onFocusCustom(input, event)`
## Imports
```js
import {
Checkbox,
Dropdown,
fieldEnhance,
Input,
Radio,
TextArea,
} from 'semantic-ui-redux-form-fields';
```
## Field HOC
All the fields are created through the `fieldEnhance` higher order component which mentioned above gives you the ability to extend and customize. t handles the `Form.Field` presentational logic which includes error reporting and a top `label`. For example, it allows you to easily hook-up and use [React TimePicker](http://react-component.github.io/time-picker/). Check out `__tests__/fieldEnhance.HOC.spec.js` for an example how to use `fieldEnhance` with [React TimePicker](http://react-component.github.io/time-picker/).
## Field Examples
Here's a few examples, and need be there's more examples in `__tests__`. Also check out the `__tests__/fieldEnhance.HOC.spec.js`
### Checkbox
```js
import React from 'react';
import { Field, reduxForm } from 'redux-form';
import { Checkbox } from 'semantic-ui-redux-form-fields';
const SemanticFormCheckbox = (props) => {
const { currentValue, handleSubmit, pristine, submitting } = props;
return (
Submit
);
};
export default reduxForm({
// a unique identifier for this form
form: 'Semantic_Checkbox_Form'
})(SemanticFormCheckbox);
```
### Input
```js
import React from 'react';
import { Field, reduxForm } from 'redux-form';
import { Input } from 'semantic-ui-redux-form-fields';
const SemanticFormInput = (props) => {
const { currentValue, handleSubmit, pristine, submitting } = props;
return (
Submit
);
};
export default reduxForm({
// a unique identifier for this form
form: 'Semantic_Input_Form'
})(SemanticFormInput);
```
### Dropdown
```js
import React from 'react';
import { Field, reduxForm } from 'redux-form';
import { Dropdown } from 'semantic-ui-redux-form-fields';
const checkboxOptions = [{
value: 'one', text: 'one', key: 'one',
}, {
value: 'two', text: 'two', key: 'two',
}, {
value: 'three', text: 'three', key: 'three',
}];
const SemanticFormDropdown = (props) => {
const { currentValue, handleSubmit, pristine, submitting } = props;
return (
Submit
);
};
export default reduxForm({
// a unique identifier for this form
form: 'Semantic_Dropdown_Form'
})(SemanticFormDropdown);
```
---
Best, te