https://github.com/sanity-io/plugin-template-tool-with-routing

Plugin template for a tool that includes basic routing
https://github.com/sanity-io/plugin-template-tool-with-routing

Last synced: 16 days ago
JSON representation

Plugin template for a tool that includes basic routing

• Host: GitHub
• URL: https://github.com/sanity-io/plugin-template-tool-with-routing
• Owner: sanity-io
• License: mit
• Archived: true
• Created: 2017-11-07T16:34:04.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-10-28T00:39:23.000Z (about 2 years ago)
• Last Synced: 2024-07-31T20:27:58.124Z (3 months ago)
• Language: JavaScript
• Homepage: https://www.sanity.io/
• Size: 9.77 KB
• Stars: 1
• Watchers: 7
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-sanity - `plugin-template-tool-with-routing` - Plugin template for a tool that includes basic routing. (Plugins / Plugin templates)

README

        
# plugin-template-tool-with-routing

Plugin template for a tool that includes basic routing.

## Main take-aways

- Tools implement the part named `part:@sanity/base/tool`

- The file that implements the tool part needs to export an object containing properties such as a name, title, icon and React component to render. See `template/index.js`.

- Sanity has a router that can be used to map certain paths to certain actions. See the [router documentation](https://github.com/sanity-io/sanity/tree/master/packages/%40sanity/state-router) for more info.

- A preconfigured Sanity client can be imported from the part `part:@sanity/base/client`. The configuration from the studios `sanity.json` is used.

## Usage

`sanity init plugin https://github.com/sanity-io/plugin-template-tool-with-routing/archive/master.zip`

## License

MIT-licensed. See LICENSE.