Added macro helpers for export availability

[rickgoemans]

Intro

I've added some useful macros to the Nova Field which helps to determine a whether a field is available on the export or not.

There are 3 macros:

• hideOnExport - The field can be available on index requests but will not be shown on export requests
• onlyOnExport - The field is only available on export requests
• showOnExport - The field is available on export requests and maybe create/update requests, depending on the defined logic.

Reason

The reason for this is on the index and/or detail requests you'll want to format fields like email addresses and phone numbers as HTML using a displayUsing callback. But this results in errors saying that the displayUsing callback is receiving a null value where it expects a string. You could change the type hinting to ?string or remove the type hinting, but that is not a good solution in my opinion.

Example (which throws errors):

Text::make(__('Email'), 'email')
  ->rules('required', 'email')
  ->displayUsing(fn(string $email): string => "<a target='_blank' href='mailto:{$email}'>{$email}</a>")
  ->asHtml(),

Solution (after this being merged):

Text::make(__('Email'), 'email')
  ->rules('required', 'email')
  ->displayUsing(fn(string $email): string => "<a target='_blank' href='mailto:{$email}'>{$email}</a>")
  ->asHtml()
  ->hideOnExport(),

Text::make(__('Email'), 'email')
  ->onlyOnExport(),

Outro

I'm wondering what others think of this solution and maybe this can get merged so others can enjoy these helpful macros.

[patrickbrouwers]

Nice! I've had a similar idea for a while. Nice PR. I'll review it soon!

[vesper8]

I need this as well.. either that or a way to transform before export so I can strip the html tags

Any chance you'll merge this soon @patrickbrouwers ?

[patrickbrouwers]

I'll review it after my holiday is over

[GautierDele]

@patrickbrouwers did you have any time to review this ? This is a really needed feature if you can have a look 😄
Either #114 or this one.

Thanks

[patrickbrouwers]

Not yet, but I think I'll be happy to add both solutions.

[GautierDele]

Yes I agree, this one is more clean but mine allows to join external table easily. might be good to merge both yes

[rickgoemans]

Any progress on the merge? I don't understand the reason for the styleci to fail, is it because of the no newline at the end of the file?

[patrickbrouwers]

@rickgoemans no worries about styleci, it will run after merge anyway.

I haven't gotten around to it yet, but still on my planning to merge it.

[patrickbrouwers]

Thanks @rickgoemans for the great addition! Can you add some documentation for this over there: https://docs.laravel-excel.com/nova/1.x/exports/customizations.html (https://github.com/maatwebsite/laravel-excel-docs/edit/master/nova/1.x/exports/customizations.md)