2.1.17 • Published 4 years ago
@matt-dunn/react-wireframes v2.1.17
@matt-dunn/react-wireframes
React component to annotate your components — useful for prototypes and proof of concepts.
Getting Started
npm install --save @matt-dunn/react-wireframes
or
yarn add @matt-dunn/react-wireframes
Annotate a component
const AnnotatedMyComponent = withWireframeAnnotation({
title: "MyComponent title",
description: "MyComponent description.",
})(MyComponent);
Wrap your application with the container
<WireframeContainer>
<AnnotatedMyComponent />
{/*...application*/}
</WireframeContainer>
API
See Storybook.
Example Implementation
This example shows a set of components annotated using react-wireframes
.
Simple bare-bones example
import ReactDOM from "react-dom";
import React from "react";
import {
WireframeContainer, withWireframeAnnotation,
} from "@matt-dunn/react-wireframes";
const MyComponent = () => <article>Hello world</article>;
const AnnotatedMyComponent = withWireframeAnnotation({
title: "MyComponent title",
description: "MyComponent description.",
})(MyComponent);
const app = (
<WireframeContainer>
<AnnotatedMyComponent />
</WireframeContainer>
);
ReactDOM.render(
app,
document.getElementById("app"),
);
License
The MIT License (MIT) Copyright (c) 2020 Matt Dunn
2.1.17
4 years ago
2.1.16
4 years ago
2.1.15
4 years ago
2.1.14
4 years ago
2.1.13
4 years ago
2.1.12
4 years ago
2.1.9
4 years ago
2.1.10
4 years ago
2.1.11
4 years ago
2.1.4
4 years ago
2.1.6
4 years ago
2.1.5
4 years ago
2.1.7
4 years ago
2.1.2
4 years ago
2.1.3
4 years ago
2.1.1
4 years ago
2.0.7
4 years ago
2.0.6
4 years ago
2.0.5
4 years ago
2.0.4
4 years ago
2.0.3
4 years ago
2.0.2
4 years ago
2.0.1
4 years ago
2.0.0
4 years ago
1.3.0
4 years ago
1.2.3
4 years ago
1.2.2
4 years ago
1.2.1
4 years ago
1.2.0
4 years ago
1.1.5
4 years ago
1.1.4
4 years ago
1.1.3
4 years ago
1.1.2
4 years ago
1.1.1
4 years ago
1.1.0
4 years ago
1.0.27
4 years ago
1.0.22
4 years ago
1.0.21
4 years ago
1.0.26
4 years ago
1.0.25
4 years ago
1.0.24
4 years ago
1.0.23
4 years ago
1.0.20
4 years ago
1.0.19
4 years ago
1.0.18
4 years ago
1.0.17
4 years ago