Aphrodite: Inline Styles that work
Support for colocating your styles with your JavaScript component.
- Works great with and without React
- Supports media queries without window.matchMedia
- Supports pseudo-selectors like
:hover
,:active
, etc. without needing to store hover or active state in components.:visited
works just fine too. - Supports automatic global
@font-face
detection and insertion. - Respects precedence order when specifying multiple styles
- Requires no AST transform
- Injects only the exact styles needed for the render into the DOM.
- Can be used for server rendering
- Few dependencies, small (20k, 6k gzipped)
- No external CSS file generated for inclusion
- Autoprefixes styles
Installation
Aphrodite is distributed via npm:
npm install --save aphrodite
API
;; { return <div> <span className=> This is red </span> <span className=> This turns red on hover </span> <span className=> This turns red when the browser is less than 600px width </span> <span className=> This is blue </span> <span className=> This is blue and turns red when the browser is less than 600px width </span> </div>; } const styles = StyleSheet;
Server-side rendering
To perform server-side rendering, make a call to StyleSheetServer.renderStatic
, which takes a callback. Do your rendering inside of the callback and return the generated HTML. All of the calls to css()
inside of the callback will be collected and the generated css as well as the generated HTML will be returned.
To perform rehydration, call StyleSheet.rehydrate
with the list of generated class names returned to you by StyleSheetServer.renderStatic
.
As an example:
; // Contains the generated html, as well as the generated css and some// rehydration data.var html css = StyleSheetServer; // Return the base HTML, which contains your rendered HTML as well as a// simple rehydration script.return ` <html> <head> <style data-aphrodite></style> </head> <body> <div id='root'></div> <script src="./bundle.js"></script> <script> StyleSheet.rehydrate(); ReactDOM.render(<App/>, document.getElementById('root')); </script> </body> </html>`;
Font Faces
Creating custom font faces is a special case. Typically you need to define a global @font-face
rule. In the case of aphrodite we only want to insert that rule if it's actually being referenced by a class that's in the page. We've made it so that the fontFamily
property can accept a font-face object (either directly or inside an array). A global @font-face
rule is then generated based on the font definition.
const coolFont = fontFamily: "CoolFont" fontStyle: "normal" fontWeight: "normal" src: "url('coolfont.woff2') format('woff2')"; const styles = StyleSheet;
Aphrodite will ensure that the global @font-face
rule for this font is only inserted once, no matter how many times it's referenced.
Use without React
Aphrodite was built with React in mind, but does not depend on React. Here, you can see it used with Web Components:
; const styles = StyleSheet; { thisinnerHTML = ` This is red. `; } document;
Caveats
Style injection and buffering
Aphrodite will automatically attempt to create a <style>
tag in the document's <head>
element to put its generated styles in. Aphrodite will only generate one <style>
tag and will add new styles to this over time. If you want to control which style tag Aphrodite uses, create a style tag yourself with the data-aphrodite
attribute and Aphrodite will use that instead of creating one for you.
To speed up injection of styles, Aphrodite will automatically try to buffer writes to this <style>
tag so that minimum number of DOM modifications happen.
Aphrodite uses asap to schedule buffer flushing. If you measure DOM elements' dimensions in componentDidMount
or componentDidUpdate
, you can use setTimeout
function to ensure all styles are injected.
; Component { return <div ref="root" className= />; } { // At this point styles might not be injected yet. thisrefsrootoffsetHeight; // 0 or 10 ; } const styles = StyleSheet;
Assigning a string to a content property for a pseudo-element
When assigning a string to the content
property it requires double or single quotes in CSS.
Therefore with Aphrodite you also have to provide the quotes within the value string for content
to match how it will be represented in CSS.
As an example:
const styles = StyleSheet;
The generated css will be:
Tools
- Aphrodite output tool - Paste what you pass to
StyleSheet.create
and see the generated CSS
TODO
- Add Flow annotations
- Add JSdoc
- Enable ESlint
- Consider removing !important from everything.
Other solutions
License (MIT)
Copyright (c) 2016 Khan Academy
Includes works from https://github.com/garycourt/murmurhash-js, which is MIT licensed with the following copyright:
Copyright (c) 2011 Gary Court
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.