Skip to content

Commit a3b19c5

Browse files
committed
refactor: update component implementation status and improve documentation
1 parent f83c333 commit a3b19c5

File tree

1 file changed

+7
-55
lines changed

1 file changed

+7
-55
lines changed

README.md

Lines changed: 7 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ Our comprehensive collection of UI components with implementation status:
5353
-**Sidebar** - Collapsible side navigation
5454
-**Tabs** - Tabbed interfaces
5555
-**Tree** - Hierarchical data structures
56-
-**Navigation** - Main navigation component
5756
-**Stepper** - Multi-step process indicator
5857
-**Pagination** - Page navigation controls
5958

@@ -68,7 +67,6 @@ Our comprehensive collection of UI components with implementation status:
6867
-**Switch** - Toggle controls
6968
-**Textarea** - Multi-line text inputs
7069
-**Form** - Form validation and state management
71-
-**Select** - Standard dropdown select
7270
-**DatePicker** - Date selection component
7371
-**TimePicker** - Time selection component
7472
-**FileUpload** - File upload component
@@ -85,8 +83,8 @@ Our comprehensive collection of UI components with implementation status:
8583
-**Label** - Form labels
8684
-**Link** - Navigation links
8785
-**List** - Structured lists
86+
-**Card** - Content containers
8887
-**Table** - Simple data tables
89-
-**Card** - Content containers
9088
-**Chip** - Compact information display
9189
-**Progress** - Progress indicators
9290
-**Skeleton** - Loading placeholders
@@ -110,25 +108,17 @@ Our comprehensive collection of UI components with implementation status:
110108
-**Notification** - System notifications
111109
-**Spotlight** - Feature highlighting
112110

113-
### Media & Graphics
114-
115-
-**Image** - Enhanced image component
116-
-**Gallery** - Image gallery component
117-
-**Carousel** - Content carousel
118-
-**Video** - Video player component
119-
-**Chart** - Data visualization charts
120-
121111
### Utilities & Layout
122112

123113
-**Portal** - Declare a portal anywhere in DOM
124114
-**Teleport** - Render content in a specific portal
125115
-**Root** - Application root container
126116
-**Layer** - Layer management utility
127117
-**Collapsible** - Generic collapsible wrapper
128-
-**Container** - Layout container
118+
-**Container** - Layout container
119+
-**Scrollable** - Custom scrollbar component
129120
-**Spacer** - Space management utility
130121
-**Responsive** - Responsive utilities
131-
-**ScrollArea** - Custom scrollbar component
132122
-**VirtualList** - Virtual scrolling list
133123

134124
### Status: **35/65** components implemented (54%)
@@ -163,11 +153,11 @@ Each component follows a consistent Bond pattern:
163153
```typescript
164154
class MyComponentBond extends Bond<MyComponentBondState> {
165155
static CONTEXT_KEY = '@atoms/context/my-component';
166-
156+
167157
static get(): MyComponentBond | undefined {
168158
return getContext(MyComponentBond.CONTEXT_KEY);
169159
}
170-
160+
171161
static set(bond: MyComponentBond): MyComponentBond {
172162
return setContext(MyComponentBond.CONTEXT_KEY, bond);
173163
}
@@ -382,7 +372,7 @@ For more control, you can use the Bond system directly:
382372

383373
@svelte-atoms/core is completely headless, giving you full control over styling. Here are some approaches:
384374

385-
### CSS Classes
375+
### Using Vanilla CSS
386376

387377
```css
388378
/* Default button styles */
@@ -399,40 +389,18 @@ For more control, you can use the Bond system directly:
399389
}
400390
```
401391

402-
### CSS-in-JS with Style Props
392+
### Using Tailwind CSS
403393

404394
```svelte
405395
<Button.Root class="rounded-md bg-blue-600 px-4 py-2 text-white hover:bg-blue-700">
406396
Styled Button
407397
</Button.Root>
408398
```
409399

410-
### Custom CSS Variables
411-
412-
```css
413-
:root {
414-
--atomic-primary: #3b82f6;
415-
--atomic-secondary: #6b7280;
416-
--atomic-success: #10b981;
417-
--atomic-danger: #ef4444;
418-
--atomic-warning: #f59e0b;
419-
}
420-
421-
.atomic-button {
422-
background-color: var(--atomic-primary);
423-
color: white;
424-
}
425-
```
426-
427400
---
428401

429402
## 🧪 Development
430403

431-
### Prerequisites
432-
433-
- Node.js 18+
434-
- Bun (recommended) or npm
435-
436404
### Setup
437405

438406
1. **Clone the repository:**
@@ -465,22 +433,6 @@ For more control, you can use the Bond system directly:
465433
npm run storybook
466434
```
467435

468-
### Testing
469-
470-
```bash
471-
# Run all tests
472-
bun test
473-
474-
# Unit tests only
475-
bun test:unit
476-
477-
# E2E tests only
478-
bun test:e2e
479-
480-
# Run tests in watch mode
481-
bun test:unit --watch
482-
```
483-
484436
### Building
485437

486438
```bash

0 commit comments

Comments
 (0)