Skip to content

Commit d26d91b

Browse files
authored
doc: Prepare an introduction page for storybook (#210)
1 parent adcb60b commit d26d91b

File tree

3 files changed

+33
-1
lines changed

3 files changed

+33
-1
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# sendbird-uikit
22

3-
[![Version 3 beta](https://img.shields.io/badge/Sendbird-BETA-blue.svg)](https://github.com/sendbird/sendbird-uikit-react/tree/develop-v3)
43
[![Platform React](https://img.shields.io/badge/Platform-React-orange.svg)](https://reactjs.org)
54
[![Language TypeScript](https://img.shields.io/badge/Language-TypeScript-orange.svg)](https://www.typescriptlang.org/)
65

src/ui/Docs/Introduction.tsx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import React from "react";
2+
3+
export default function Introduction(): JSX.Element {
4+
return (
5+
<article>
6+
<h1>Welcome to <i>@sendbird/uikit-react/ui</i> Storybook</h1>
7+
<main>
8+
<p>The list of UI components can be founder under `@sendbird/uikit-react/ui` in left panel</p>
9+
<p>Use Docs tab on the top(beside canvas tab) to read docs and play around with the components</p>
10+
</main>
11+
</article>
12+
);
13+
}

src/ui/Docs/stories/Doc.stories.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import React from 'react';
2+
import Introduction from '../Introduction';
3+
4+
const description = `
5+
\`@sendbird/uikit-react/ui/Introduction\`
6+
`;
7+
8+
export default {
9+
title: '@sendbird/uikit-react/ui/Introduction',
10+
component: Introduction,
11+
parameters: {
12+
docs: {
13+
description: {
14+
component: description,
15+
},
16+
},
17+
},
18+
};
19+
20+
export const WithControl = (arg) => <Introduction {...arg} />;

0 commit comments

Comments
 (0)