sanity-plugin-internationalized-array
5.3.75.3.8
README.md~
README.mdModified+20
Index: package/README.md
===================================================================
--- package/README.md
+++ package/README.md
@@ -6,8 +6,9 @@
- [sanity-plugin-internationalized-array](#sanity-plugin-internationalized-array)
- [Installation](#installation)
- [Usage for simple field types](#usage-for-simple-field-types)
+ - [Passing options to the underlying field](#passing-options-to-the-underlying-field)
- [Loading languages](#loading-languages)
- [Configuring the "Add translation" buttons](#configuring-the-add-translation-buttons)
- [Using complex field configurations](#using-complex-field-configurations)
- [Creating internationalized objects](#creating-internationalized-objects)
@@ -77,8 +78,27 @@
}),
]
```
+## Passing options to the underlying field
+
+Options on an `internationalizedArray*` field are copied onto each language row's `value` field. Use this for settings that belong to that field type, such as which files an `internationalizedArrayFile` accepts:
+
+```ts
+defineField({
+ name: 'subtitles',
+ title: 'Subtitles/Captions',
+ type: 'internationalizedArrayFile',
+ options: {
+ accept: '.vtt,.srt,text/vtt,application/x-subrip',
+ },
+})
+```
+
+`languages`, `apiVersion`, and `select` belong to the plugin and are not copied. Options already set on the type in `fieldTypes` stay in place, and options on an individual field override them.
+
+`collapsed` is not currently supported. Setting it has no effect.
+
## Loading languages
Languages must be an array of objects with an `id` and `title`.