quilt_rails 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801ba2d2d619ae8c7a6714bf69f06a8edeb2ae7edc1d0255f8e9df57755be211
-  data.tar.gz: bc17c1c983af45c573a589c1c9ae84d241b1af242a996d33998aa360ef560ae7
+  metadata.gz: 7dd3a1819df8890a210390afc49273715e052de27f62484e194a5aa577d4783b
+  data.tar.gz: e09486d3a9274e9ae539dfba6b533f0c1caff6a217706d990d4dd3286c9a1425
 SHA512:
-  metadata.gz: a3f14ae99c0e106a9b3a71606c7489c20c99446a91e8ddfe20ed7b294bab50a358927cb6f6e70ed295b814fe7b520039e7f14dcb68cb1a2d7395b934f92f3c3d
-  data.tar.gz: 21b493fecf60259353c8df068c219d51de3eb3859cf4889bc8f44b6c4ea8f2993c6e08d1f58dad0585bf98d9f10128a4001e651528afb779d3008f5b8ca902b1
+  metadata.gz: 6ced5760673f5410ddfb4eefdd3ab87a2708e0de26eaddce0a27e51a9a596a28b0936e18eb410ac87f175209fc039a8a46b4b106a31139b99ea331de942f7b49
+  data.tar.gz: 1376c88df0991345ca4c05dc18e89cbcbf5f358c3c237f34eb6fc307646c38834ed19d1e35d7ee413a01672c072f50eb4715f416bf2d9deffc97fee795033610

data/README.md

@@ -329,9 +329,39 @@ function App() {
 export default App;
 ```
 
+##### Example: sending custom headers from Rails controller
+
+In some cases you may want to send custom headers from Rails to your React server. Quilt facilitates this case by providing consumers with a `headers` argument on the `render_react` call.
+
+```ruby
+class ReactController < ApplicationController
+  include Quilt::ReactRenderable
+
+  def index
+    render_react(headers: {'x-custom-header': 'header-value-a'})
+  end
+end
+```
+
+Headers can be accessed during server-side-rendering with the `useRequestHeader` hook from `@shopify/react-network`.
+
+```tsx
+// app/ui/index.tsx
+
+import React from 'react';
+import {useRequestHeader} from '@shopify/react-network';
+
+function App() {
+  const header = useRequestHeader('x-custom-header');
+  return <h1>Data: {header}</h1>;
+}
+
+export default App;
+```
+
 ##### Example: sending custom data from Rails controller
 
-In some cases you may want to send custom headers or basic data from Rails to your React server. Quilt facilitates this case by providing consumers with a `headers` and `data` argument on the `render_react` call.
+In some cases you may want to send basic data from Rails to your React server. Quilt facilitates this case by providing consumers with a `data` argument on the `render_react` call.
 
 **Note:** The data passed should be data that is unlikely or will never change over the course of the session before they render any React components.
 
@@ -340,12 +370,12 @@ class ReactController < ApplicationController
   include Quilt::ReactRenderable
 
   def index
-    render_react(headers: {'x-custom-header': 'header-value-a'}, data: {'some_id': 123})
+    render_react(data: {'some_id': 123})
   end
 end
 ```
 
-The React server will serialize the provided quilt data using `x-quilt-data` as the ID. You can then get this serialized data on the client with `getSerialized` from `@shopify/react-html`.
+The React server will serialize the provided quilt data using `quilt-data` as the ID. You can then get this serialized data on the client with `getSerialized` from `@shopify/react-html`.
 
 ```tsx
 // app/ui/index.tsx
@@ -356,10 +386,10 @@ import {getSerialized} from '@shopify/react-html';
 const IS_CLIENT = typeof window !== 'undefined';
 
 function App() {
-  // get `x-quilt-data` from the request that was sent through Rails ReactController
-  const quiltData = IS_CLIENT ? getSerialized<{[key: string]: any}>('x-quilt-data') : null;
+  // get the serialized data from the request that was sent through Rails ReactController
+  const quiltData = IS_CLIENT ? getSerialized<Record<string, any>>('quilt-data') : null;
 
-  // Logs {"x-custom-header":"header-value-a","some_id":123}
+  // Logs {"some_id":123}
   console.log(quiltData);
 
   return <h1>Data: {quiltData}</h1>;
@@ -368,6 +398,23 @@ function App() {
 export default App;
 ```
 
+If using the webpack plugin, this will be done automatically and the data will be passed into your application as the `data` prop.
+
+```tsx
+// app/ui/index.tsx
+
+import React from 'react';
+
+function App({data}: {data: Record<string, any>}) {
+  // Logs {"some_id":123}
+  console.log(data);
+
+  return <h1>Data: {data}</h1>;
+}
+
+export default App;
+```
+
 ##### Example: redirecting
 
 ```tsx

data/lib/quilt_rails/performance/report.rb

@@ -9,7 +9,7 @@ module Quilt
 
       def self.from_params(params)
         params.transform_keys! { |key| key.underscore.to_sym }
-        params.require(:connection)
+        params[:connection] = { effectiveType: 'unknown' } if params[:connection].blank?
 
         connection = Connection.from_params(params[:connection])
 

data/lib/quilt_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Quilt
-  VERSION = "1.12.0"
+  VERSION = "1.12.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quilt_rails
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - Mathew Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties