LaravelPackages.net
Acme Inc.
Toggle sidebar
henryavila/laravel-nova-chordpro-field

Add a Chordpro viewer and editor into Laravel Nova. The editor is a simple TextArea. The viewer display a fully formatted song.

76
1
1.2.0
About henryavila/laravel-nova-chordpro-field

henryavila/laravel-nova-chordpro-field is a Laravel package for add a chordpro viewer and editor into laravel nova. the editor is a simple textarea. the viewer display a fully formatted song.. It currently has 1 GitHub stars and 76 downloads on Packagist (latest version 1.2.0). Install it with composer require henryavila/laravel-nova-chordpro-field. Discover more Laravel packages by henryavila or browse all Laravel packages to compare alternatives.

Last updated

Laravel Nova Chordpro Field

Add a Chordpro viewer and editor into Laravel Nova. The editor is a simple TextArea. The viewer display a fully formatted song.

The following chordpro code

{title: 005 - Tua Vontade}
{subtitle: Adoradores 2}
{key: E}
{tempo: 75}
{time: 6/8}
{duration: 03:57}


{c: (INTRODUÇÃO)}
[E]x//     [F#m7]x//     [D9]x//     [D9]x//
[E]x//     [F#m7]x//     [D9]x//     [D9]x//


[E]Norte ou Sul, [F#m7]noite ou  di[E/G#]-a eu te [A]seguirei [A] 
[E]Mesmo que o mundo [F#m7]me abando [E/G#]- ne eu [A]serei fiel [A]
[B]Onde mandares [A]irei segurando em [E]tuas mãos [E]  
[B/D#]Sejas meus olhos e [A/C#]guies o meu cora[E]ção

{soc}
[E]    Que eu [B]siga a tua vonta [B]- de e que 
[C#m7]sempre a missão me acompa [C#m7]- nhe
Que eu [B/D#]seja a estrela da noi [B/D#]- te 
sempre a bri[A/E]lhar por [E]Ti
[E]    Eu sou [B]filho do Rei do univer [B]- so,
{eoc}

will be rendered inside Laravel Nova Field as

image

also, supports dark mode

image

If the Chorpro has some invalid content, it will be displayed in Detail view

image

This package is built with https://github.com/chordproject/chorpro-parser and https://github.com/eKoopmans/html2pdf.js and allows to

  • Edit chordpro (simple TextArea editor)
  • View a fully formatted song
  • Display chordpro parser errors
  • Generate a pdf with the formatted song
  • Translate the displayed text like "Key", "Time", etc

Prerequisites

Laravel Nova 4+

Installation

In a Laravel nova instance, install henryavila/laravel-nova-chordpro-field

composer require henryavila/laravel-nova-chordpro-field

Localization

Publish the package language files to your application's resources/lang/vendor directory:

php artisan vendor:publish --provider="Henryavila\LaravelNovaChordproField\FieldServiceProvider"

Usage

Assuming you have a Nova Resource with the chordpro content in the chordpro column, the following code will render the chordpro as displayed in the image above


// Laravel Nova Resource
use \Henryavila\LaravelNovaChordproField\ChordproField;

public function fields(Request $request): array
 {
      return [
        ...
        ChordproField::make('Chordpro')
              ->alwaysShow()
              ->rules('required'),
        ...
    ];
}

Usage Options

| Option | Description | Default Value | | ------------- | ------------- |------------- | | showTabs() | Display tablature |true | | useSimpleChord() | Simplify the chords. Ex: E/G# becomes E |false | | showChords() | Display the chords. If set to false, will display just the lyrics |true | | rows() | Number of rows in the edit form |20 |

Usign all options with differents values

// Laravel Nova Resource
use \Henryavila\LaravelNovaChordproField\ChordproField;

public function fields(Request $request): array
 {
      return [
        ...
        ChordproField::make('Chordpro')
              ->alwaysShow()
              ->rows(30)
              ->showTabs(false)
              ->useSimpleChord()
              ->showChords(false)
              ->rules('required'),
        ...
    ];
}
Comments