74 lines
1.2 KiB
Markdown
74 lines
1.2 KiB
Markdown
# @coze-arch/hooks
|
|
|
|
coze arch hooks
|
|
|
|
## Overview
|
|
|
|
This package is part of the Coze Studio monorepo and provides architecture functionality. It serves as a core component in the Coze ecosystem.
|
|
|
|
## Getting Started
|
|
|
|
### Installation
|
|
|
|
Add this package to your `package.json`:
|
|
|
|
```json
|
|
{
|
|
"dependencies": {
|
|
"@coze-arch/hooks": "workspace:*"
|
|
}
|
|
}
|
|
```
|
|
|
|
Then run:
|
|
|
|
```bash
|
|
rush update
|
|
```
|
|
|
|
### Usage
|
|
|
|
```typescript
|
|
import { /* exported functions/components */ } from '@coze-arch/hooks';
|
|
|
|
// Example usage
|
|
// TODO: Add specific usage examples
|
|
```
|
|
|
|
## Features
|
|
|
|
- Core functionality for Coze Studio
|
|
- TypeScript support
|
|
- Modern ES modules
|
|
|
|
## API Reference
|
|
|
|
### Exports
|
|
|
|
- `default as useHover`
|
|
- `default as usePersistCallback`
|
|
- `default as useUpdateEffect`
|
|
- `default as useToggle`
|
|
- `default as useUrlParams`
|
|
- `default as useStateRealtime`
|
|
|
|
|
|
For detailed API documentation, please refer to the TypeScript definitions.
|
|
|
|
## Development
|
|
|
|
This package is built with:
|
|
|
|
- TypeScript
|
|
- Modern JavaScript
|
|
- Vitest for testing
|
|
- ESLint for code quality
|
|
|
|
## Contributing
|
|
|
|
This package is part of the Coze Studio monorepo. Please follow the monorepo contribution guidelines.
|
|
|
|
## License
|
|
|
|
Apache-2.0
|