README.md

Styled Components Sample

This project was bootstrapped with this handy template from this article. Most of the changes to that template were to add styled-components support.

To enable the @fullstory/babel-plugin-annotate-react plugin we edited the fullstory-babel-plugin-annotate-react/samples/styled-components/.babelrc file. Since this sample is using the local plugin we use ../.. as the plugin name (around line 3) but you should use the npm package name of @fullstory/babel-plugin-annotate-react.

To test this sample:

cd fullstory-babel-plugin-annotate-react/samples/styled-components/
npm install
npm run start

A browser window should open and you can compare the source components in fullstory-babel-plugin-annotate-react/samples/styled-components/src/components/App.js to the rendered DOM. Look for the data-component, data-element, and data-source-file attributes added by this plugin.

A note about attribute names

If you use the usual React code patterns for Components then they'll be tagged with data-component and if you use libs like styled-components to create DOM then they'll be tagged with the variable name in data-element.

For example, here are two styled components and a normal React.Component:

const Title = styled.h1`
	font-size: 1.5em;
`;
const Anchor = styled.a`
	color: purple;
`;
class App extends Component {
	render() {
		return (
			<div className="foo">
				<Title>
					A title
					<br />
					<Anchor href="#foo">
						An anchor
					</Anchor>
				</Title>
			</div>
		);
	}
}

And this is the render:

<div class="foo" data-component="App" data-source-file="App.js">
	<h1 data-element="Title" data-source-file="App.js" class="App__Title-sc-17 kmanzR">
		A title
		<br>
		<a href="#foo" data-element="Anchor" data-source-file="App.js" class="App__Anchor-sc-17 dFfJuD">
			An anchor
		</a>
	</h1>
</div>