Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/talyssonoc/react-laravel
Package for using ReactJS with Laravel
https://github.com/talyssonoc/react-laravel
laravel php react server-side-rendering
Last synced: 15 days ago
JSON representation
Package for using ReactJS with Laravel
- Host: GitHub
- URL: https://github.com/talyssonoc/react-laravel
- Owner: talyssonoc
- Created: 2015-04-05T14:16:57.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-27T08:21:41.000Z (almost 5 years ago)
- Last Synced: 2024-10-04T09:52:38.136Z (about 1 month ago)
- Topics: laravel, php, react, server-side-rendering
- Language: PHP
- Homepage:
- Size: 255 KB
- Stars: 896
- Watchers: 41
- Forks: 90
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://codeclimate.com/github/talyssonoc/react-laravel) [](https://travis-ci.org/talyssonoc/react-laravel)
# react-laravel
With `react-laravel` you'll be able to use [ReactJS](https://facebook.github.io/react/) components right from your Blade views, with optional server-side rendering, and use them on the client-side with React due to unobtrusive JavaScript.
# Installation
## V8js dependency
It's important to know that `react-laravel` has an indirect dependency of the [v8js](https://pecl.php.net/package/v8js) PHP extension.
You can see how to install it here: [how to install v8js](install_v8js.md).
## Composer
Set the `minimum-stability` of your `composer.json` to `dev`, adding this:
```json
"minimum-stability": "dev"
```
Then run:
```sh
$ composer require talyssonoc/react-laravel:0.11
```
After that you should add this to your providers at the `config/app.php` file of your Laravel app:
```php
'React\ReactServiceProvider'
```
And then run:
```sh
php artisan vendor:publish
```
And the `react.php` file will be available at the `config` folder of your app.
# Usage
After the installation and configuration, you'll be able to use the `@react_component` directive in your views.
The `@react_component` directive accepts 3 arguments:
```php
@react_component([, props, options])
//example
@react_component('Message', [ 'title' => 'Hello, World' ], [ 'prerender' => true ])
// example using namespaced component
@react_component('Acme.Message', [ 'title' => 'Hello, World' ], [ 'prerender' => true ])
```
* `componentName`: Is the name of the global variable that holds your component. When using [Namespaced Components](https://facebook.github.io/react/docs/jsx-in-depth.html#namespaced-components) you may use dot-notation for the component name.
* `props`: Associative of the `props` that'll be passed to your component
* `options`: Associative array of options that you can pass to the `react-laravel`:
* `prerender`: Tells react-laravel to render your component server-side, and then just _mount_ it on the client-side. Default to __true__.
* `tag`: The tag of the element that'll hold your component. Default to __'div'__.
* _html attributes_: Any other valid HTML attribute that will be added to the wrapper element of your component. Example: `'id' => 'my_component'`.
All your components should be inside `public/js/components.js` (you can configure it, see below) and be global.
You must include `react.js`, `react-dom.js` and `react_ujs.js` (in this order) in your view. You can concatenate these files together using laravel-elixir.
`react-laravel` provides a ReactJS installation and the `react_us.js` file, they'll be at `public/vendor/react-laravel` folder after you install `react-laravel` and run:
```sh
$ php artisan vendor:publish --force
```
For using the files provided by `react-laravel` and your `components.js` file, add this to your view:
```html
```
If you'll use a different version from the one provided by react-laravel (see `composer.json`), you got to configure it (see below).
# Configurations
You can change settings to `react-laravel` at the `config/react.php` file:
```php
return [
'source' => 'path_for_react.js',
'dom-source' => 'path_for_react-dom.js',
'dom-server-source' => 'path_for_react-dom-server.js',
'components' => [ 'path_for_file_containing_your_components.js' ]
];
```
All of them are optional.
* `source`: defaults to `public/vendor/react-laravel/react.js`.
* `dom-source`: defaults to `public/vendor/react-laravel/react-dom.js`.
* `dom-server-source`: defaults to `public/vendor/react-laravel/react-dom-server.js`.
* `components`: defaults to `public/js/components.js`. Multiple components files may be specified here.
Your `components.js` file(s) should also be included at your view, and all your components must be at the `window` object.
# Thanks
This package is inspired at [react-rails](https://github.com/reactjs/react-rails).