Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document hasDocument option #893

Merged
merged 6 commits into from
Mar 13, 2017
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/page-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ This `next function may be used to call the default implementation of the
function in question.

`handleRoute(request:Request, loader:Loader, next: Function), optional:
{code?: int, location?: String, page?:Page} | Promise({code?: int, location?:
{code?: int, location?: String, page?:Page, hasDocument?: boolean} | Promise({code?: int, location?:
String, page?:Page})`

* This method is called before any of the other methods, and its purpose is to
Expand All @@ -103,6 +103,9 @@ String, page?:Page})`
results in HTML and late arrival of HTTP responses that occur after a
rendering timeout.

* If an error code is returned, and a custom page needs to be presented to the user,
an additional property `hasDocument` can be returned: `{code: 404, hasDocument: true}`.

* If the `code` is 301 or 302, then it must also return a `location` String to
tell the browser where to redirect.

Expand Down
5 changes: 5 additions & 0 deletions packages/react-server-examples/bike-share/components/error.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import React from 'react';

export default () => {
return (<div className="error">404 - The page you were looking for was not found.</div>);
};
32 changes: 32 additions & 0 deletions packages/react-server-examples/bike-share/pages/not-found.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import React from 'react';
import {RootElement} from 'react-server';

import Header from '../components/header';
import Footer from '../components/footer';
import Error from '../components/error';

import '../styles/index.scss';

export default class NotFoundPage {
handleRoute () {
return {code: 404, hasDocument: true};
}

getElements () {
return [
<RootElement key={0}>
<Header/>
</RootElement>,
<RootElement key={1}>
<Error />
</RootElement>,
<RootElement key={2}>
<Footer/>
</RootElement>,
]
}

getBodyClasses() {
return ['page-body'];
}
}
4 changes: 4 additions & 0 deletions packages/react-server-examples/bike-share/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,9 @@ module.exports = {
method: 'get',
page: './pages/network',
},
NotFoundPage: {
path: '/(.*)',
page: './pages/not-found.js',
},
},
};
4 changes: 4 additions & 0 deletions packages/react-server-examples/bike-share/styles/base.scss
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ a {
.footer {
padding: 2rem 0rem 0rem;
}

.error {
color: red;
}