terra-switch
v1.15.0
Published
The terra-switch component provides users a way to toggle between state ON and OFF.
Downloads
19
Readme
Terra Switch
The terra-switch component, like its real-world counterpart, is used to indicate whether a setting is ON or OFF and provide users with instantaneous feedback of switch state (ON/OFF).
Switches are used to activate settings immediately, in real time. It would be usefull when you need to represent the switching between only two states like on-off state.
The difference between Switch and Checkbox is that Switch has only two states which change directly when you toggle it, while Checkbox has three states and has intermediate state initial value along with checked and unchecked state.
Getting Started
- Install with npm:
npm install terra-switch
Peer Dependencies
This component requires the following peer dependencies be installed in your app for the component to properly function.
| Peer Dependency | Version | |-|-| | react | ^16.8.5 | | react-dom | ^16.8.5 |
LICENSE
Copyright 2020 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.