Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christophrumpel/missing-livewire-assertions
Adding the missing Livewire assertions to your Laravel project
https://github.com/christophrumpel/missing-livewire-assertions
laravel livewire
Last synced: 24 days ago
JSON representation
Adding the missing Livewire assertions to your Laravel project
- Host: GitHub
- URL: https://github.com/christophrumpel/missing-livewire-assertions
- Owner: christophrumpel
- License: mit
- Created: 2021-04-19T16:23:41.000Z (over 3 years ago)
- Default Branch: production
- Last Pushed: 2024-04-11T15:24:05.000Z (7 months ago)
- Last Synced: 2024-10-01T09:22:55.082Z (about 1 month ago)
- Topics: laravel, livewire
- Language: PHP
- Homepage:
- Size: 104 KB
- Stars: 136
- Watchers: 5
- Forks: 24
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# This Package Adds Missing Livewire Test Assertions
[](https://packagist.org/packages/christophrumpel/missing-livewire-assertions)
[](https://github.com/christophrumpel/missing-livewire-assertions/actions?query=workflow%3Arun-tests+branch%3Aproduction)
[](https://github.com/christophrumpel/missing-livewire-assertions/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Aproduction)
[](https://packagist.org/packages/christophrumpel/missing-livewire-assertions)
This package adds some nice new Livewire assertions which I was missing while testing my applications using Livewire. If you want to know more about WHY I needed them, check out my [blog article](https://christoph-rumpel.com/2021/4/how-I-test-livewire-components).
➡️ `Version 2.0` of this package only supports `Livewire 3`. Please use a lower version of this package for other Livewire versions.
## Installation
You can install the package via composer:
```bash
composer require christophrumpel/missing-livewire-assertions
```
## Usage
The new assertions get added automatically, so you can use them immediately.
### Check if a Livewire property is wired to an HTML field
```php
Livewire::test(FeedbackForm::class)
->assertPropertyWired('email');
```
It looks for a string like `wire:model="email"` in your component's view file. It also detects variations like `wire:model.live="email"`, `wire:model.lazy="email"`, `wire:model.debounce="email"`, `wire:model.lazy.10s="email"` or `wire:model.debounce.500ms="email"`.
### Check if a Livewire method is wired to an HTML field
```php
Livewire::test(FeedbackForm::class)
->assertMethodWired('submit');
```
It looks for a string like `wire:click="submit"` in your component's view file.
### Check if a Livewire magic action is wired to an HTML field
```php
Livewire::test(FeedbackForm::class)
->assertMethodWired('$toggle(\'sortAsc\')');
```
### Check if a generic Livewire method is wired to an HTML field
```php
Livewire::test(FeedbackForm::class)
->assertMethodWiredToAction('mouseenter', 'enter');
```
It looks for a string like `wire:mouseenter="enter"` in your component's view file. Also, note that it can also look for any events, like `wire:keydown` or `wire:custom-event`.
It looks for a string like `wire:click="$refresh"`, `wire:click="$toggle('sortAsc')`, `$dispatch('post-created')`, along with all other [magic actions](https://livewire.laravel.com/docs/actions#magic-actions). When testing for magic actions, you must escape single quotes like shown above.
### Check if a Livewire method is wired to an HTML form
```php
Livewire::test(FeedbackForm::class)
->assertMethodWiredToForm('upload');
```
It looks for a string like `wire:submit.prevent="upload"` in your component's view file.
### Check if a Livewire method is wired to a specific javascript event
```php
Livewire::test(FeedbackForm::class)
->assertMethodWiredToEvent('setValue', 'change');
```
It looks for a string like `wire:change.debounce.150ms="setValue"` in your component's view file.
You can also check for actions without any additional modifiers:
```php
Livewire::test(FeedbackForm::class)
->assertMethodWiredToEventWithoutModifiers('reset', 'keyup');
```
This will match `wire:keyup="reset"`, but not `wire:keyup.escape="reset"`. You could match that with
```php
Livewire::test(FeedbackForm::class)
->assertMethodWiredToEventWithoutModifiers('reset', 'keyup.escape');
```
### Check if a Livewire component contains another Livewire component
```php
Livewire::test(FeedbackForm::class)
->assertContainsLivewireComponent(CategoryList::class);
```
You can use the component tag name as well:
```php
Livewire::test(FeedbackForm::class)
->assertContainsLivewireComponent('category-list');
```
### Check if a Livewire component contains a Blade component
```php
Livewire::test(FeedbackForm::class)
->assertContainsBladeComponent(Button::class);
```
You can use the component tag name as well:
```php
Livewire::test(FeedbackForm::class)
->assertContainsBladeComponent('button');
```
### Check to see if a string comes before another string
```php
Livewire::test(FeedbackForm::class)
->assertSeeBefore('first string', 'second string');
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Christoph Rumpel](https://github.com/christophrumpel)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.