-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,35 @@ | ||
# Statamic character counting field ![Statamic 3](https://img.shields.io/badge/statamic-3.x-blue.svg?style=flat-square) | ||
# Statamic character counting field | ||
|
||
[![StyleCI](https://styleci.io/repos/75275215/shield?branch=master)](https://styleci.io/repos/75275215) | ||
![Statamic 3.0+](https://img.shields.io/badge/Statamic-3.0+-FF269E?style=for-the-badge&link=https://statamic.com) | ||
|
||
An input field or textarea which shows the status of the length | ||
with colored feedback on the input element. | ||
> An input field or textarea which shows the status of the length | ||
> with colored feedback on the input element. | ||
![CharField](https://raw.githubusercontent.com/appswithlove/statamic-charfield/master/screenshot-v3.png) | ||
## Installation | ||
|
||
Install with Composer: | ||
|
||
composer require appswithlove/statamic-charfield | ||
|
||
## Usage | ||
|
||
## Configuration | ||
Use the «Extended Section» field and choose the background you like in the blueprint editor. | ||
|
||
### Configuration | ||
|
||
| Option | Description | | ||
|---------------|----------------------------------------| | ||
| `input_type` | Choose between input or textarea | | ||
| `min` | Minimal length | | ||
| `max` | Maximal length | | ||
| `low` | Minimal length | | ||
| `high` | Maximal length | | ||
| `optimal_min` | Optional min length for optimal result | | ||
| `optimal_max` | Optional max length for optimal result | | ||
| `hard_limit` | Maxlength for input field | | ||
|
||
- If the length is outside of min and max the color is **red**. | ||
- If the length is between min and max but not between the optimal length **dark yellow** | ||
- If the length is in the optional range or between min and max if no optimal length is provided the color is **green** | ||
- If the length is outside of min and max the color is **red**. | ||
- If the length is between min and max but not between the optimal length **dark yellow** | ||
- If the length is in the optional range or between min and max if no optimal length is provided the color is **green** | ||
|
||
## Screenshot | ||
|
||
![CharField](https://raw.githubusercontent.com/appswithlove/statamic-charfield/master/screenshot-v3.png) |