Skip to content

Commit 35ab172

Browse files
committed
Update readme
1 parent 89974e9 commit 35ab172

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,49 @@
22

33
React wrapper components for [VSCode Elements](https://vscode-elements.github.io).
44

5+
## Install
6+
57
```bash
68
npm i @vscode-elements/react-elements
79
```
810

11+
## A minimal working example
12+
13+
```typescript
14+
import {
15+
VscodeBadge,
16+
VscodeTabHeader,
17+
VscodeTabPanel,
18+
VscodeTabs,
19+
} from "@vscode-elements/react-elements";
20+
21+
function App() {
22+
const [count, setCount] = useState(0);
23+
24+
return (
25+
<>
26+
<VscodeTabs
27+
onVscTabsSelect={(e) => {
28+
console.log(e);
29+
}}
30+
>
31+
<VscodeTabHeader>
32+
Lorem
33+
<span slot="content-after">
34+
<VscodeBadge variant="counter">10</VscodeBadge>
35+
</span>
36+
</VscodeTabHeader>
37+
<VscodeTabPanel>panel content 1</VscodeTabPanel>
38+
<VscodeTabHeader>Ipsum</VscodeTabHeader>
39+
<VscodeTabPanel>panel content 2</VscodeTabPanel>
40+
</VscodeTabs>
41+
</>
42+
);
43+
}
44+
45+
export default App;
46+
```
47+
48+
949
> [!WARNING]
1050
> The package is not complete yet; only a subset of components is covered.

0 commit comments

Comments
 (0)