davidpiesse / nova-toggle
A Boolean Toggle Switch Field
Installs: 958 144
Dependents: 3
Suggesters: 0
Security: 0
Stars: 86
Watchers: 3
Forks: 30
Open Issues: 29
Language:Vue
Requires
- php: ^7.3|^8.0
- dev-master
- v4.x-dev
- 4.0
- 0.0.8
- 0.0.7
- 0.0.6
- 0.0.5
- 0.0.4
- 0.0.3
- 0.0.2
- 0.0.1
- dev-dependabot/npm_and_yarn/express-4.18.2
- dev-dependabot/npm_and_yarn/decode-uri-component-0.2.2
- dev-dependabot/npm_and_yarn/loader-utils-1.4.2
- dev-dependabot/npm_and_yarn/css-what-2.1.3
- dev-dependabot/npm_and_yarn/url-parse-1.5.10
- dev-dependabot/npm_and_yarn/follow-redirects-1.14.8
- dev-dependabot/npm_and_yarn/chownr-1.1.4
- dev-oct-refresh
This package is auto-updated.
Last update: 2024-12-08 21:41:56 UTC
README
A drop in replacement for the default Boolean field
Installation
Same as most other Nova Packages
composer require davidpiesse/nova-toggle
Usage
The Toggle has all the same options as the Boolean field so you can set the values to be stored in the Model.
use Davidpiesse\NovaToggle\Toggle;
Toggle::make('Active') ->trueValue('On') ->falseValue('Off')
In addition you can set visual parameters
Labels
You can show both, or each state label
Toggle::make('Active') ->showLabels() //Both labels ->showOnlyTrueLabel() //True label only ->showOnlyFalseLabel() //False label only
To set the text you can use either or both of the following. You must also set the visibility of the labels as described above.
Toggle::make('Active') ->showLabels() ->trueLabel('Tru Dat') ->falseLabel('Nah Dawg')
The defaults are 'True' and 'False'
Size
You can set the width and height. Setting the width will auto scale the height, but you can override this with ->height(). Defaults are 60 (px) and 26 (px)
Toggle::make('Active') ->width(80) ->height(45) //To override scaling
Colors
You can set wither or both of the background colours for the Toggle. By default True is the Nova 'Success Green' [ var(--success) ] and false is a Grey 60 [ var(--60) ]
Toggle::make('Active') ->trueColor('pink') ->falseColor('#fcfcfc')
Speed
You can set the animation speed in ms with
Toggle::make('Active') ->speed(500)
The default is 300ms
Toggle on index
You can activate the toggle on index as well with
Toggle::make('Active') ->editableIndex()