Installations

npm install sanity-plugin-note-field

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>=14

Node Version

16.15.1

NPM Version

8.11.0 Pull Requests

Open

0

Total

4

Closed

2

Merged

2

Issues

Open

2

Total

8

Closed

6

Releases

Unable to fetch releases

Languages

2

TypeScript

JavaScript

TypeScript (82.74%)

JavaScript (17.26%)

Developer

ndimatteo

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

46 Stars

21 Commits

6 Forks

2 Watchers

2 Branches

3 Contributors

Updated on Jul 07, 2025

Maintainers

1

View All 3 Contributors

Package Meta Information

Latest Version

2.0.2

Package Id

sanity-plugin-note-field@2.0.2

Unpacked Size

24.40 kB

Size

6.68 kB

File Count

17

NPM Version

8.11.0

Node Version

16.15.1

Published on

Feb 28, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

4

@sanity/incompatible-plugin @sanity/ui lodash prop-types

Peer Dependencies

2

react sanity

Dev Dependencies

21

Note Fields for Sanity

Display inline notes within your schemas
✨ uses Sanity UI ✨ multiple styles ✨ dark mode compatible ✨

note-field-v3

🔌 Install

1yarn add sanity-plugin-note-field
2# or npm
3npm i sanity-plugin-note-field

Warning
This is a Sanity Studio V3 plugin. For the V2 version, please refer to the studio-v2 branch.

⚙️ Configure

1// `sanity.config.ts` / `sanity.config.js`:
2import { defineConfig } from 'sanity'
3import { noteField } from 'sanity-plugin-note-field'
4
5export default defineConfig({
6  // ...
7  plugins: [
8    // ...
9    noteField(),
10  ],
11})

🗒️ Usage

1defineField({
2  title: 'Important!',
3  description: 'a custom Message...',
4  name: 'myCustomNote',
5  type: 'note',
6  options: {
7    icon: () => <Warning size={20} weight="duotone" />,
8    tone: 'caution',
9  },
10})

Properties

Name	Type	Description
`type`	string	(Required) Value must be set to `note`.
`name`	string	(Required) The field name. This will be the key in the data record.
`title`	string	(Optional) Short title, appears in bold above the optional description.
`description`	string / React.Component	(Optional) Long form message, displayed under the title.

Options

Name	Type	Description
`icon`	React.Component	(Optional) Display an icon alongside your note's title/message. Just remember that any schema file with icons in them should have a .jsx or .tsx extension.
`tone`	string	(Optional) The color of the note. Accepts any of the Sanity UI Card tone values. Defaults to `primary`.

🧪 Develop & test

This plugin uses @sanity/plugin-kit with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio on how to run this plugin with hotreload in the studio.

🤝 License

MIT

nickdimatteo.com · Github @ndimatteo · Instagram @ndimatteo

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.1

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More