README

Installation

You can install the package via composer:

composer require headerx/laravel-iframes

You can publish views with:

php artisan vendor:publish --provider="HeaderX\Iframes\IframesServiceProvider" --tag="iframes-views"

You can publish the config file with:

php artisan vendor:publish --provider="HeaderX\Iframes\IframesServiceProvider" --tag="iframes-config"

If you are you are using jetstream, you may want to use replace 'web' middleware
below with 'sanctum', depending on your configurations but, this is just to say
the 'default' for jetstream is sanctum.

This is the contents of the published config file:

<?php
return [
    'theme' => 'jetstream',

    'middleware' => [
        'web',
        'auth',
    ],

    /**
     * The Route prefix under which views should be loaded in an iframe.
     * This can be useful when you want to keep the appearance of the app
     * layout but the view contains css or javascript which is incompatible,
     * such as when using a package or some legacy views.
     */
    'internal_iframe_prefix' => env('INTERNAL_IFRAME_PREFIX', 'iframes'),

    /**
     * The Route prefix under which to load external iframes,
     * such as from subdomains, static sites, or services
     * running on another backend platform or framework.
     */
    'external_iframe_prefix' =>  env('EXTERNAL_IFRAME_PREFIX', 'extras'),

    /**
     * The key in the query string which will
     * be used to load external sites inside
     * an iframe.
     */
    'external_link_key' => env('EXTERNAL_LINK_KEY', '?external_link='),
];

Usage

Install laravel jetstream, or publish the views and change the layout
Run artisan serve

External

Browse to http://localhost:8000/extras?external_link=https://example.com

Internal

Install some package with frontend stack you aren't using
Browse to http://localhost:8000/iframes/your-package-route

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

headerx / laravel-iframes

Maintainers

Details