react-body-attribute
v1.0.2
Published
A declarative, nested, stateful <body> attributes for React
Downloads
5
Maintainers
tienleReadme
React Body Attributes
Provides a declarative way to specify body attributes in a single-page app.
This component can be used on server side as well.
Built with React Side Effect. And heavily inspired by https://github.com/gaearon/react-document-title
====================
Installation
npm install --save react-body-attributeDependencies: React >= 0.13.0
Features
- Does not emit DOM, not even a
<noscript>; - Like a normal React compoment, can use its parent's
propsandstate; - Can be defined in many places throughout the application;
- Supports arbitrary levels of nesting, so you can define app-wide and page-specific titles;
- Works just as well with isomorphic apps.
Example
Assuming you use something like react-router:
var App = React.createClass({
render: function () {
// Use "My Web App" if no child overrides this
return (
<BodyAttribute bodyClass='page'>
<HomePage />
</BodyAttribute>
);
}
});
var HomePage = React.createClass({
render: function () {
// Use "Home" while this component is mounted
return (
<BodyAttribute bodyClass='home'>
<h1>Home, sweet home.</h1>
</BodyAttribute>
);
}
});
Result:
<body class="home"></body>Note: All attributes must be prefixed by body.
Server Usage
If you use it on server, call BodyAttribute.rewind() after rendering components to string to retrieve the title given to the innermost DocumentTitle. You can then embed this title into HTML page template.
Because this component keeps track of mounted instances, you have to make sure to call rewind on server, or you'll get a memory leak.