Skip to content

Commit 634df7b

Browse files
committed
docs: updates readme content
1 parent cef15cb commit 634df7b

1 file changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
# @dschz/solid-auto-sizer
66

7-
![SolidJS](https://img.shields.io/badge/SolidJS-2c4f7c?logo=solid&logoColor=c8c9cb)
8-
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
97
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
108
[![npm version](https://badge.fury.io/js/@dschz%2Fsolid-auto-sizer.svg)](https://badge.fury.io/js/@dschz%2Fsolid-auto-sizer)
119
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/@dschz/solid-auto-sizer)](https://bundlephobia.com/package/@dschz/solid-auto-sizer)
@@ -139,6 +137,36 @@ type AutoSizerProps = {
139137
};
140138
```
141139

140+
## 🎮 Interactive Playground
141+
142+
Explore AutoSizer's capabilities with our comprehensive playground app! The playground includes:
143+
144+
- **Basic Examples** - Simple responsive content, resize callbacks, custom dimensions, flexbox integration
145+
- **Charts & Visualizations** - Responsive bar charts, line charts, pie charts, and dashboards
146+
- **Virtual Lists & Grids** - Performance demos with 1K-100K items, searchable lists, variable heights
147+
- **Real-time Demos** - Interactive examples you can resize and modify
148+
149+
### Running the Playground
150+
151+
```bash
152+
# Clone the repository
153+
git clone https://github.com/dsnchz/solid-auto-sizer.git
154+
cd solid-auto-sizer
155+
156+
# Install dependencies
157+
npm|pnpm|yarn|bun install
158+
159+
# Start the development server
160+
npm|pnpm|yarn|bun start
161+
```
162+
163+
The playground will be available at `http://localhost:3000` and showcases real-world use cases including:
164+
165+
- 📊 **Chart Integration** - See how AutoSizer works with data visualizations
166+
- 📋 **Virtual Scrolling** - Performance testing with large datasets
167+
- 🎨 **Styling Examples** - Custom themes and responsive designs
168+
-**Performance Monitoring** - Real-time resize event tracking
169+
142170
## 💡 Common Use Cases
143171

144172
### Charts and Visualizations

0 commit comments

Comments
 (0)