sanity-plugin-table

Table schema type and input component for Sanity CMS

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
sanity-plugin-table
31112.3.0a year ago4 years agoMinified + gzip package size for sanity-plugin-table in KB

Readme

<h1>Sanity Plugin Table</h1>

<img alt="NPM version" src="https://img.shields.io/npm/v/sanity-plugin-table?color=000&style=flat-square">
<img alt="NPM downloads" src="https://img.shields.io/npm/dm/sanity-plugin-table?color=000&style=flat-square">
<img alt="GitHub Release Date" src="https://img.shields.io/github/release-date/rdunk/sanity-plugin-table?color=000&style=flat-square">
<img alt="License" src="https://img.shields.io/npm/l/sanity-plugin-table.svg?color=000&style=flat-square">
</p>
	</p>
	<p>
		<h3><a href="https://www.sanity.io/" _target="blank">Sanity</a> plugin that implements a table schema type and input component.</h3>
	<br>
	<br>

Notice: Version 2.x of this plugin includes a breaking change, see the Configuration section to migrate existing data.



example

Install

Install using the Sanity CLI.
$ sanity install table

Usage

Simply specify table as a field type in your schema.
export default {
  name: 'product',
  title: 'Product',
  type: 'document',
  fields: [
    {
      name: 'sizeChart',
      title: 'Size Chart',
      type: 'table', // Specify 'table' type
    },
  ],
};

Configuration

You can create a configuration file to provide the _type used for table row data. This is especially useful if you are upgrading or have existing data, as version 2.x of this plugin uses tableRow by default, replacing row used in version 1.x.
In your studio, create a config/table.json file (relative to the root directory). The rowType string value can be whatever you like. Use row if you are migrating existing data from version 1 to 2.
{
  "rowType": "row"
}

License

MIT