@featherk/composables 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +70 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# @featherk/composables — Summary
|
|
2
|
+
|
|
3
|
+
IMPORTANT: This package is experimental and NOT READY FOR PRODUCTION.
|
|
4
|
+
|
|
5
|
+
> BIG DISCLAIMER — Do not use this package in production environments. The API, types, and build output are unstable. Tests and documentation are incomplete. You may encounter breaking changes, missing features, or rough edges. Use only for local experimentation or as a reference.
|
|
6
|
+
|
|
7
|
+
## Short description
|
|
8
|
+
|
|
9
|
+
`@featherk/composables` provides small Vue 3 composables intended to augment and improve accessibility and behavior for Kendo UI components (Telerik). The library is developed alongside a demo app that shows usage patterns and integration points.
|
|
10
|
+
|
|
11
|
+
## Key points
|
|
12
|
+
|
|
13
|
+
- Vue 3 + Composition API
|
|
14
|
+
- TypeScript (partial coverage; some types may be missing or incomplete)
|
|
15
|
+
- Designed to be used inside a monorepo (Turborepo) with a demo app at `demos/` and package sources in `packages/composables/src/`
|
|
16
|
+
|
|
17
|
+
## What this README contains
|
|
18
|
+
|
|
19
|
+
- Purpose and high-level features
|
|
20
|
+
- Current stability/status and the critical disclaimer
|
|
21
|
+
- Quick local build / demo steps to try the code (for contributors)
|
|
22
|
+
- Where to look in the repo for implementation and exports
|
|
23
|
+
|
|
24
|
+
## Status / Stability
|
|
25
|
+
|
|
26
|
+
This package is an early-stage library and intentionally marked as experimental:
|
|
27
|
+
|
|
28
|
+
- API: Unstable. Expect breaking changes.
|
|
29
|
+
- Types: Partial. Some public functions and returned shapes may lack strict TypeScript types.
|
|
30
|
+
- Tests: Minimal or missing. Run tests before trusting behavior.
|
|
31
|
+
- Documentation: Sample usage is mainly in the demo app; inline documentation is minimal.
|
|
32
|
+
- Compatibility: Not officially supported by or affiliated with Telerik.
|
|
33
|
+
|
|
34
|
+
If you need production-ready composables, consider using broadly-adopted libraries or implementing small, well-scoped utilities locally.
|
|
35
|
+
|
|
36
|
+
## Quick start (for contributors)
|
|
37
|
+
|
|
38
|
+
From the repository root you can build and run the demo to exercise the composables locally. Replace `npm` with your package manager if needed.
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# build the composables package only
|
|
42
|
+
npm run build:composables
|
|
43
|
+
|
|
44
|
+
# run the demo app (dev server)
|
|
45
|
+
npm run dev:demo
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Where to look
|
|
49
|
+
|
|
50
|
+
- Source code: `packages/composables/src/`
|
|
51
|
+
- Public exports: `packages/composables/src/index.ts`
|
|
52
|
+
- Types: `packages/composables/src/types/`
|
|
53
|
+
- Demo usage: `demos/src/components/composables/` and `demos/src/App.vue`
|
|
54
|
+
|
|
55
|
+
## Contributing notes
|
|
56
|
+
|
|
57
|
+
- Add composables inside `packages/composables/src/` and export them from `index.ts`.
|
|
58
|
+
- Keep changes small and documented. Add tests for new behavior where reasonable.
|
|
59
|
+
- Build the composables package before running the demo to ensure the demo picks up local changes.
|
|
60
|
+
|
|
61
|
+
## Next steps (recommended)
|
|
62
|
+
|
|
63
|
+
- Add unit tests and a CI job (currently missing or minimal).
|
|
64
|
+
- Improve TypeScript coverage for public API shapes.
|
|
65
|
+
- Add examples and API docs for each composable.
|
|
66
|
+
- Consider adding a clear versioning strategy (semver) and a roadmap stating when the package will be considered stable.
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
See top-level `LICENSE` for repository licensing information.
|