Skip to content

Commit 14c4cd9

Browse files
committed
chore: bump version to v0.1.0
1 parent 4a870f0 commit 14c4cd9

File tree

3 files changed

+96
-2
lines changed

3 files changed

+96
-2
lines changed

CHANGELOG.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# @dschz/solid-highcharts
2+
3+
## 0.1.0 (2025-06-04)
4+
5+
### 🎉 Initial Release
6+
7+
This is the first stable release of `@dschz/solid-highcharts`, a comprehensive SolidJS wrapper for Highcharts that provides type-safe, reactive chart components.
8+
9+
### ✨ Features
10+
11+
- **📊 Complete Highcharts Support**: Factory functions for all Highcharts variants
12+
- `createChart()` - Standard charts (line, bar, pie, etc.)
13+
- `createStockChart()` - Financial and time-series data visualization
14+
- `createMapChart()` - Geographical data visualization
15+
- `createGanttChart()` - Project management and timeline visualization
16+
- **🎯 Type-Safe**: Full TypeScript support with proper type inference
17+
- **⚡ Reactive**: Seamless integration with SolidJS reactivity system
18+
- **🧹 Lifecycle Management**: Automatic chart cleanup and memory management
19+
- **📱 Responsive**: Built-in responsive chart behavior
20+
- **🔄 Chart Updates**: Reactive updates when props change (with Gantt chart considerations)
21+
- **🎨 Full Customization**: Complete access to all Highcharts configuration options
22+
- **📦 ESM Ready**: Full support for Highcharts v12+ ESM imports
23+
24+
### 🔧 Core Components
25+
26+
- **Base Factory**: `createChartComponent()` - Low-level component factory
27+
- **Chart Types**: Pre-configured factories for all Highcharts chart types
28+
- **TypeScript Types**: Comprehensive type definitions for all chart variants
29+
- **Props Interface**: Clean, extensible component props with callbacks and styling
30+
31+
### 🏗️ Architecture
32+
33+
- **Minimal Abstraction**: Direct mapping to Highcharts options API
34+
- **Discrete Series Objects**: Type-safe patterns for dynamic chart types
35+
- **Native Type Preservation**: Respects Highcharts' native type system
36+
- **Modular Design**: Import only what you need
37+
38+
### 📚 Documentation
39+
40+
- **Comprehensive README**: Complete setup and usage guide
41+
- **⚖️ Licensing Information**: Clear guidance on Highcharts commercial licensing
42+
- **📦 Installation Guide**: Multiple package manager support (npm, yarn, pnpm, bun)
43+
- **🔧 Configuration Examples**: Real-world usage patterns
44+
- **📈 Performance Tips**: SolidJS-specific optimization guidance
45+
- **🎨 Styling Guide**: CSS and theming examples
46+
- **🧪 Testing Examples**: Unit and integration testing patterns
47+
48+
### 🎮 Playground & Examples
49+
50+
- **Interactive Playground**: Comprehensive demo application
51+
- **Chart Showcase**: Examples for all chart types
52+
- Basic Charts (line, bar, area, pie with dynamic switching)
53+
- Stock Charts with real-time data simulation
54+
- Map Charts with real topology data and multiple regions
55+
- Gantt Charts with project timeline examples
56+
- **Navigation**: Modern sidebar navigation with active state detection
57+
- **Responsive Design**: Mobile-friendly interface with Tailwind CSS
58+
59+
### 🧪 Testing Infrastructure
60+
61+
- **Test Setup**: Vitest + jsdom configuration
62+
- **Testing Library**: SolidJS testing library integration
63+
- **Example Tests**: Component rendering and interaction tests
64+
- **Mock Support**: Highcharts mocking patterns for unit tests
65+
66+
### 🔄 Highcharts v12+ Support
67+
68+
- **ESM Imports**: Recommended import patterns for Highcharts v12+
69+
- **Legacy Compatibility**: Backward compatibility with pre-v12 UMD imports
70+
- **Module Loading**: Proper side-effect import patterns for additional modules
71+
- **Import Ordering**: Clear documentation on critical import sequence requirements
72+
73+
### 🐛 Known Limitations
74+
75+
- **Gantt Chart Reactivity**: Gantt charts are not reactive to prop changes due to Highcharts read-only property constraints
76+
- **Import Ordering**: Highcharts modules must be imported after core module (documented)
77+
78+
### 💻 Development
79+
80+
- **Build System**: Vite-based build with TypeScript
81+
- **Code Quality**: ESLint + Prettier configuration
82+
- **Package Management**: Bun-optimized development workflow
83+
- **CI/CD**: GitHub Actions workflow for testing and publishing
84+
85+
### 🔗 Dependencies
86+
87+
- **SolidJS**: ^1.8.0+ (peer dependency)
88+
- **Highcharts**: 12.0.0+ (peer dependency)
89+
- **TypeScript**: Full type support with strict mode
90+
91+
### 📄 License
92+
93+
- **Wrapper Library**: MIT License
94+
- **Highcharts**: Commercial license required for commercial use (see documentation)

jsr.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@dschz/solid-highcharts",
3-
"version": "0.0.0",
3+
"version": "0.1.0",
44
"license": "MIT",
55
"exports": "./src/index.tsx",
66
"publish": {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@dschz/solid-highcharts",
3-
"version": "0.0.0",
3+
"version": "0.1.0",
44
"description": "SolidJS wrapper for Highcharts",
55
"type": "module",
66
"author": "Daniel Sanchez <dsanc89@icloud.com>",

0 commit comments

Comments
 (0)