Download the PHP package aw-studio/laravel-consent without Composer
On this page you can find all versions of the php package aw-studio/laravel-consent. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-consent
Laravel Consent
This package provides headless blade-components for building consents, e.g. cookie-consents.
Consents are being stored in local-storage.
Installation
Install via composer:
Components
The Laravel Consent package comes with three blade components: <x-consent-wrapper>, <x-consent> and <x-consent-toggle>.
Consent Wrapper
The <x-consent-wrapper> component is used to group consents. You can style each wrapper to your liking. Every wrapper needs an unique id.
Each wrapper component shows the full list of consents and a Save-Button. After saving the wrapper is hidden.
| Attributes | Type | Description | required |
|---|---|---|---|
| id | String | unique id for grouping consents | ✅ |
| save | String | Save-button text |
Consent
The <x-consent> component is used for actually giving a consent and MUST be wrapped by a <x-consent-wrapper> and neeeds a unique id.
Each consent has a label and and checkbox. The label text is filled with the content of the default slot.
When giving a consent, you may want to execute a local script or load a script from a source.
If you want to load an external script after the consent the component should look as follows:
The script will be appended to the <head>.
If you want to execute a local script you can provide the code in the <x-slot name="script"> of your <x-consent>:
| Attributes | Type | Description | required |
|---|---|---|---|
| id | String | ✅ | |
| preselect | bool | wheter the checkbox should be preselected | |
| src | bool | external script src to be loaded after the consent was given | |
| callback | bool | callback to be called after external script was loaded |
Consent Toggle
Sometimes you may want to provide a 'one-time-consent'. This can be achieved using the <x-consent-toggle> component. You may place it anywhere in your markup where a corresponding <x-consent> exists. A toggle is linked to a consent by providing the same id to the toggle. A toggle may be styled to your liking.
The following toggle will fire the callback of the google-maps consent:
| Attributes | Type | Description | required |
|---|---|---|---|
| id | String | id of the consent to toggle | ✅ |
| button | String | button text | ✅ |
| button-class | String | classes to style the button |
Full example
In this example, a consent wrapper with to consents is presented: