sanity-plugin-dashboard-widget-notes v0.4.1

dashboard-widget-notes

Dashboard widget for the Sanity Content Studio which lets you write simple "post-it" notes.

Uses polished.js to find the best contrast depending on the luminosity of the given backgroundColor. Override with color in options.

Quick start

Install the plugin in your Sanity Studio project folder:

sanity install dashboard-widget-notes

Add to dashboardConfig.js:

export default {
  widgets: [
    { name: 'notes' }
    // ...the rest of your widgets
  ]
}

Options

There are some options available.

title (string)

Widget title. Defaults to Notes

{
  name: 'notes',
  options: {
    title: 'My notes'
  }
}

placeholder (string)

Placeholder text in the <textarea>. Defaults to ...

{
  name: 'notes',
  options: {
    title: 'My notes',
    placeholder: 'What is up?'
  }
}

backgroundColor (string)

Background color for the widget. A black or white text color is set automatically depending on the luminosity. Defaults to #ffff88

{
  name: 'notes',
  options: {
    title: 'My notes',
    placeholder: 'What is up?',
    backgroundColor: '#eee',
  }
}

color (string)

Override text color for the widget.

{
  name: 'notes',
  options: {
    title: 'My notes',
    placeholder: 'What is up?',
    backgroundColor: '#eee',
    color: 'red',
  }
}

Local development

1. Fork/clone this repo
2. Install dependencies (yarn or npm install)
3. Link for local development (yarn link or npm link)
4. Run build to compile your changes (yarn build or npm run build)
5. Link in a local studio folder (yarn link "sanity-plugin-dashboard-widget-notes" or npm link sanity-plugin-dashboard-widget-notes)
6. Add sanity-dashboard-widget-notes to the plugin array in sanity.json
7. Add {name: 'notes'} to your dashboardConfig.js