https://github.com/sixlive/nova-text-copy-field
Nova text field with click to copy support
https://github.com/sixlive/nova-text-copy-field
laravel nova php
Last synced: 6 months ago
JSON representation
Nova text field with click to copy support
- Host: GitHub
- URL: https://github.com/sixlive/nova-text-copy-field
- Owner: sixlive
- License: mit
- Created: 2018-10-08T18:10:15.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-15T11:23:53.000Z (about 6 years ago)
- Last Synced: 2025-04-02T22:06:06.163Z (6 months ago)
- Topics: laravel, nova, php
- Language: Vue
- Homepage:
- Size: 1.06 MB
- Stars: 70
- Watchers: 3
- Forks: 15
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Nova Text Copy Field
[](https://packagist.org/packages/sixlive/nova-text-copy-field)
[](https://packagist.org/packages/sixlive/nova-text-copy-field)
[](https://github.styleci.io/repos/152124692)
A Laravel Nova text field with click to copy support. This field behaves just like a text field but adds the ability to copy the field value to your clipboard with just a click.
This package can also be found on [Nova Packages](https://novapackages.com/packages/sixlive/nova-text-copy-field).
## Installation
```bash
> composer require sixlive/nova-text-copy-field
```
## Usage
Add the field to a resource.
```php
use Sixlive\TextCopy\TextCopy;
public function fields(Request $request)
{
return [
TextCopy::make('Example Copy Field', 'example_copy_field'),
];
}
```
### Truncating long strings
In some cases you may want to truncate the display of a fields value but allow still copy the full value. You can use the `truncate()` method to accomplish this.
```php
TextCopy::make('Some Long Field')
->truncate(100)
```
### Masking the field value
This works great for secrets like API Keys.
```php
TextCopy::make('Some Secret String', 'some_secret_string')
->mask('❌') // default '*'
->truncate(5)
```
### Copy button title
The title of the copy button defaults to the field name prefixed with 'Copy'. For example, `TextCopy::make('Some Field', 'some_field')` the button title will be "Copy Some Field".
If you would like to manually set the title you can use the `copyButtonTitle()` method.
```php
TextCopy::make('Some Field', 'some_field')
->copyButtonTitle('Some alternative title')
```
### Alternative copy value
You can choose to mutate and that is copied to the users clipboard. You can either pass a value or a Closure.
```php
TextCopy::make('Some Secret String', 'some_long_string')
->copyValue(function ($value) {
return substr($value, -6);
})
```
or
```php
TextCopy::make('Some Secret String', 'some_long_string')
->copyValue('some fixed copy value')
```
### Only displaying the button on hover
```php
TextCopy::make('Some Secret String', 'some_long_string')
->showButtonOnlyOnHover()
```
## Screenshots
### Default State
### Success State
When the field value has been successfully copied to the user's clipboard.
### Error State
When there is an error adding the field value to the user's clipboard.
### Truncated Display Value
### Masked Display Value
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Code Style
StyleCI will apply the [Laravel preset](https://docs.styleci.io/presets#laravel).
## Security
If you discover any security related issues, please email oss@tjmiller.co instead of using the issue tracker.
## Credits
- [TJ Miller](https://github.com/sixlive)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.