Skip to content

chore: fix sample code in README.md #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roseline124 merged 2 commits into from
Sep 5, 2025
Merged

chore: fix sample code in README.md #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7885316
chore: fix sample code in README.md
roseline124 Sep 5, 2025
d14b883
chore: version up
roseline124 Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 45 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,21 @@ import { Tree, TreeItem, TreeItemLayout } from '@roseline124/react-tree';

function App() {
return (
<Tree aria-label="File Explorer">
<TreeItem>
<TreeItemLayout>Documents</TreeItemLayout>
<Tree>
<TreeItem>
<TreeItemLayout>Work</TreeItemLayout>
<Tree>
<TreeItem>
<TreeItemLayout>Project A</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>Project B</TreeItemLayout>
</TreeItem>
</Tree>
<Tree aria-label="Default" open dropDownIcon=">">
<TreeItem itemType="leaf">
<TreeItemLayout>customer id: 1234567890</TreeItemLayout>
</TreeItem>
<TreeItem itemType="branch">
<TreeItemLayout>customer information</TreeItemLayout>
<Tree className="ml-4">
<TreeItem itemType="leaf">
<TreeItemLayout>name: roseline</TreeItemLayout>
</TreeItem>
<TreeItem itemType="leaf">
<TreeItemLayout>birthday: 1980.01.01</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>Personal</TreeItemLayout>
<TreeItem itemType="leaf">
<TreeItemLayout>gender: female</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
Expand All @@ -63,36 +61,42 @@ function App() {
### Tree with JSON Data

```tsx
import { TreeWithJson } from '@roseline124/react-tree';

const treeData = [
{
id: '1',
label: 'Documents',
children: [
{
id: '2',
label: 'Work',
children: [
{ id: '3', label: 'Project A' },
{ id: '4', label: 'Project B' },
],
},
{
id: '5',
label: 'Personal',
import { TreeData, TreeWithJson } from '@roseline124/react-tree';

const sampleData = {
'root leaf': {
root: 'leaf',
},
customer: {
'customer information': {
name: 'roseline',
birthday: '1980.01.01',
gender: 'female',
},
address: {
defaultAddress: {
city: 'seoul',
avenue: 'gangnam',
},
],
detailAddress: '101-101',
},
},
];
} satisfies TreeData;

function App() {
return (
<TreeWithJson
data={treeData}
renderItem={({ item, level }) => (
<div className="p-2">
{item.label} (Level: {level})
treeProps={{ open: true, dropDownIcon: <DropdownIcon /> }}
data={sampleData}
renderTreeItem={({
level: _level,
key,
value,
itemType,
keyPath: _keyPath,
}) => (
<div>
[{itemType}] {key} {typeof value === 'string' ? `: ${value}` : ''}
</div>
)}
/>
Expand All @@ -110,7 +114,7 @@ import { Tree, TreeItem, TreeItemLayout } from '@roseline124/react-tree';
function App() {
return (
<Tree className="p-4 bg-gray-50 rounded-lg">
<TreeItem>
<TreeItem itemType="leaf">
<TreeItemLayout className="hover:bg-blue-100 p-2 rounded">
Custom Styled Item
</TreeItemLayout>
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@roseline124/react-tree",
"version": "0.0.4-alpha.0",
"version": "0.0.5-alpha.0",
"private": false,
"description": "A customizable, accessible React Tree component built with TypeScript",
"author": "roseline124 <guseod24@gmail.com>",
Expand Down
Loading