https://github.com/ssiyad/frappe-straw
Yet another straw to consume Frappe, for React
https://github.com/ssiyad/frappe-straw
frappe frappe-framework javascript react typescript
Last synced: 20 days ago
JSON representation
Yet another straw to consume Frappe, for React
- Host: GitHub
- URL: https://github.com/ssiyad/frappe-straw
- Owner: ssiyad
- License: gpl-3.0
- Created: 2024-10-07T09:58:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-09T07:27:16.000Z (23 days ago)
- Last Synced: 2025-04-09T08:32:36.586Z (23 days ago)
- Topics: frappe, frappe-framework, javascript, react, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/frappe-straw
- Size: 355 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-frappe - Frappe Straw - Developer focused React/TypeScript hooks and utilities for Frappe. (Uncategorized / Uncategorized)
README
## Demo
You can install the demo app from
[here](https://github.com/ssiyad/frappe-straw-demo). It contain example code
and a playground. This can also be used as a test suite for development of this
plugin.## Installation
```shell
npm install frappe-straw
```Example
```typescript
import { useDocument } from 'frappe-straw';
import { type BaseDocument } from 'frappe-straw/types';const { data, error, loading, refresh } = useDocument(
'Role',
'Guest',
{
fetchOnMount: false,
},
);
```## Inspirations
- [Frappe JS SDK](https://github.com/The-Commit-Company/frappe-js-sdk)
- [frappe-ui](https://ui.frappe.io/)## License
[GPLv3](LICENSE)