https://github.com/devtical/nova-qrcode-field

A Laravel Nova field to generate QR Code
https://github.com/devtical/nova-qrcode-field

laravel laravel-nova laravel-package nova qr qr-code qr-codes qr-generator qrcode qrcode-generator

Last synced: about 13 hours ago
JSON representation

A Laravel Nova field to generate QR Code

• Host: GitHub
• URL: https://github.com/devtical/nova-qrcode-field
• Owner: devtical
• License: mit
• Created: 2018-10-09T15:17:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-12T03:23:36.000Z (21 days ago)
• Last Synced: 2025-01-25T05:05:16.483Z (8 days ago)
• Topics: laravel, laravel-nova, laravel-package, nova, qr, qr-code, qr-codes, qr-generator, qrcode, qrcode-generator
• Language: Vue
• Homepage: https://packagist.org/packages/devtical/nova-qrcode-field
• Size: 431 KB
• Stars: 43
• Watchers: 2
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nova QR Code

[![Latest Version on Packagist](https://img.shields.io/packagist/v/devtical/nova-qrcode-field.svg?style=flat-square)](https://packagist.org/packages/devtical/laravel-drunk-on-419)

[![Total Downloads](https://img.shields.io/packagist/dt/devtical/nova-qrcode-field.svg?style=flat-square)](https://packagist.org/packages/devtical/laravel-drunk-on-419)

A Laravel Nova field to generate QR Code.

![Logo & background](art/cover.png)

## Installation

You can install the Nova field in to a [Laravel](http://laravel.com) app that uses [Nova](http://nova.laravel.com) via composer :

```cli

composer require devtical/nova-qrcode-field

```

## Usage

```

use Devtical\Qrcode\Qrcode;

```

#### Basic QR Code

To create a basic QR code with default settings:

```php

Qrcode::make('QR Code', 'field')

```

#### Setting QR Code Sizes

Specify the sizes for index and detail views:

```php

Qrcode::make('QR Code', 'field')

    ->indexSize(100)     // QR size for index view

    ->detailSize(500)    // QR size for detail view

```

![Size](art/1-size.png)

### Margin Customization

Control the padding around the QR code for optimal appearance:

```php

Qrcode::make('QR Code', 'field')

    ->margin(10)

```

The margin value for the QR code adjusts based on its size: if the size is greater than `250`, it uses the margin value specified in `->margin()`, otherwise it defaults to a margin value of `1`.

### Adding a Logo

Add a logo to the center of the QR code:

```php

Qrcode::make('QR Code', 'field')

    ->logo('http://source.to/logo.png')

```

![Logo](art/2-logo.png)

### Setting a Background Image

Set a background image for the QR code:

```php

Qrcode::make('QR Code', 'field')

    ->background('http://source.to/background.png')

```

![Background](art/3-background.png)

### Combining Logo & Background

Include both a logo and a background image for the QR code:

```php

Qrcode::make('QR Code', 'field')

    ->logo('http://source.to/logo.png')

    ->background('http://source.to/background.png')

```

![Logo & background](art/4-logo-background.png)

## Dynamic Field Visibility

You can dynamically hide the QR Code field based on another field's value:

#### Hiding the Field Conditionally

Use `hideWhen()` to hide the QR Code field when a condition is met:

```php

Qrcode::make('QR Code', 'code')

    ->hideWhen(function ($resource) {

        return $resource->status === 0; // Hide if status is inactive

    });

```

## Related

- [Nova QR Code Manager](https://github.com/Devtical/nova-qrcode-manager)

## Credits

- [vue-qr](https://github.com/Binaryify/vue-qr)

- [Awesome-qr.js](https://github.com/SumiMakito/Awesome-qr.js)

## License

The MIT License (MIT).