UNPKG

woby

Version:

A high-performance framework with fine-grained observable/signal-based reactivity for building rich applications.

github.com/wongchichong/woby

wongchichong/woby

119 lines (96 loc) • 6.58 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# Woby Documentation Wiki This directory contains the comprehensive documentation wiki for the Woby framework. The wiki is organized into sections covering everything from basic concepts to advanced usage patterns. ## 📚 Documentation Structure ### Getting Started - **[Home](./Home.md)** - Main wiki landing page with navigation - **[Installation](./Installation.md)** - Setup and installation guide - **[Quick Start](./Quick-Start.md)** - Build your first Woby app - **[Examples](./Examples.md)** - Practical examples and demos ### Core Documentation - **[Core Methods](./Core-Methods.md)** - Essential framework functions - **[Hooks](./Hooks.md)** - Built-in hooks and utilities - **[Built-in Components](./Built-in-Components.md)** - Framework components - **[Reactivity System](./Reactivity-System.md)** - Understanding observables - **[Class Management](./Class-Management.md)** - Advanced class handling with reactive support - **[Context](./Context.md)** - Context API for sharing data between components - **[Best Practices](./Best-Practices.md)** - Recommended patterns and practices - **[Woby vs React](./Woby-vs-React.md)** - API differences and migration guide - **[React to Woby Type Conversion](./React-to-Woby-Type-Conversion.md)** - Type mapping guide for React developers - **[Component Defaults](./CUSTOM_ELEMENTS.md#component-defaults-and-two-way-synchronization)** - Two-way synchronization for custom elements - **[Type Synchronization](./Type-Synchronization.md)** - How HTML attributes sync with component props - **[Simple Type Synchronization](./Type-Sync-Simple.md)** - Straightforward approach to type sync ### Custom Elements - **[Custom Elements](./CUSTOM_ELEMENTS.md)** - Creating web components with Woby - **[Custom Element Best Practices](./Custom-Element-Best-Practices.md)** - Best practices for custom elements - **[Component Defaults](./CUSTOM_ELEMENTS.md#component-defaults-and-two-way-synchronization)** - Two-way synchronization patterns - **[Demos/Counter-Demo](./demos/Counter-Demo.md)** - Basic custom element example - **[Demos/Nested-Properties-Demo](./demos/Nested-Properties-Demo.md)** - Advanced nested properties - **[Demos/Custom-Element-Practical-Guide](./demos/Custom-Element-Practical-Guide.md)** - Comprehensive hands-on guide ### Help & Community - **[FAQ](./FAQ.md)** - Frequently asked questions - **[Contributing](./Contributing.md)** - How to contribute to Woby ## 🚀 Quick Navigation | I want to... | Go to | |-------------|-------| | **Get started quickly** | [Quick Start](./Quick-Start.md) | | **Learn the basics** | [Reactivity System](./Reactivity-System.md) | | **See examples** | [Examples](./Examples.md) | | **Manage classes** | [Class Management](./Class-Management.md) | | **Share data between components** | [Context](./Context.md) | | **Find a specific function** | [Core Methods](./Core-Methods.md) or [Hooks](./Hooks.md) | | **Learn best practices** | [Best Practices](./Best-Practices.md) | | **Compare with React** | [Woby vs React](./Woby-vs-React.md) | | **Convert React types** | [React to Woby Type Conversion](./React-to-Woby-Type-Conversion.md) | | **Implement custom elements** | [Custom Elements](./CUSTOM_ELEMENTS.md) | | **Learn custom element best practices** | [Custom Element Best Practices](./Custom-Element-Best-Practices.md) | | **See practical custom element examples** | [Custom Element Practical Guide](./demos/Custom-Element-Practical-Guide.md) | | **Understand type sync** | [Type Synchronization](./Type-Synchronization.md) or [Simple Type Synchronization](./Type-Sync-Simple.md) | | **Get help** | [FAQ](./FAQ.md) | | **Contribute** | [Contributing](./Contributing.md) | ## 📖 Reading Guide ### For Beginners 1. Start with [Installation](./Installation.md) 2. Follow [Quick Start](./Quick-Start.md) tutorial 3. Understand [Reactivity System](./Reactivity-System.md) 4. Explore [Examples](./Examples.md) ### For Experienced Developers 1. Review [Core Methods](./Core-Methods.md) for API reference 2. Check [Built-in Components](./Built-in-Components.md) for available components 3. Browse [Hooks](./Hooks.md) for utilities 4. Learn [Class Management](./Class-Management.md) for advanced class handling 5. Learn [Best Practices](./Best-Practices.md) for optimal patterns 6. See [Woby vs React](./Woby-vs-React.md) for migration guidance ### For React Developers 1. Read [Woby vs React](./Woby-vs-React.md) for key differences 2. Check [React to Woby Type Conversion](./React-to-Woby-Type-Conversion.md) for type mappings 3. Learn [Class Management](./Class-Management.md) for advanced class patterns 4. Learn [Best Practices](./Best-Practices.md) for @woby/specific patterns 5. Explore [Examples](./Examples.md) for practical usage ### For Custom Element Developers 1. Start with [Custom Elements](./CUSTOM_ELEMENTS.md) for an overview 2. Follow the [Custom Element Practical Guide](./demos/Custom-Element-Practical-Guide.md) for hands-on examples 3. Review [Custom Element Best Practices](./Custom-Element-Best-Practices.md) for advanced patterns 4. Study the [Counter Demo](./demos/Counter-Demo.md) for a complete example 5. Explore [Nested Properties Demo](./demos/Nested-Properties-Demo.md) for advanced features ### For Contributors 1. Read [Contributing](./Contributing.md) guidelines 2. Check project structure and development setup 3. Review code style and testing requirements ## 🔗 External Resources - **[GitHub Repository](https://github.com/wobyjs/woby)** - Source code and issues - **[Demo Applications](https://github.com/wobyjs/demo)** - Live examples - **[CodeSandbox Playground](https://codesandbox.io/s/playground-7w2pxg)** - Interactive environment ## 📝 Contributing to Documentation The documentation is written in Markdown and located in this `/docs` folder. To contribute: 1. Follow the [Contributing Guide](./Contributing.md) 2. Ensure examples are tested and working 3. Keep content clear and beginner-friendly 4. Cross-reference related topics 5. Update the navigation in [Home.md](./Home.md) if adding new pages ## 📋 Documentation Standards - **Examples**: All code examples should be complete and runnable - **Links**: Use relative links between wiki pages - **Style**: Follow the existing documentation style and structure - **Updates**: Keep documentation in sync with code changes --- *For the latest updates and community discussions, visit the [GitHub repository](https://github.com/wobyjs/woby).*