Skip to content

(feat) Alt Text Localization #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LucaArgentieri wants to merge 2 commits into
base: main
Choose a base branch
from
Open

(feat) Alt Text Localization #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d8471a
feat: add localization support to media plugin configuration and comp…
LucaArgentieri Jan 17, 2026
b920c06
feat: enhance localization support in media plugin with UI improvemen…
LucaArgentieri Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ export default defineConfig({
})
```


### Plugin Config

```ts
Expand All @@ -111,7 +110,7 @@ export default defineConfig({
enabled: true,
// boolean - enables an optional "Credit Line" field in the plugin.
// Used to store credits e.g. photographer, licence information
excludeSources: ['unsplash'],
excludeSources: ['unsplash']
// string | string[] - when used with 3rd party asset sources, you may
// wish to prevent users overwriting the creditLine based on the `source.name`
},
Expand All @@ -122,13 +121,46 @@ export default defineConfig({
components: {
details: CustomDetails
// Custom component for asset details (see below)
}
},
// Custom components to override default UI (see below)
locales: [
// { id: string, title: string, ...extra }[] - enable localization for asset fields. Each object must have a unique id and a human-readable title.
// You may include extra keys (e.g. isDefault) for compatibility with Sanity's recommended pattern; only id and title are used by the plugin, all other keys are ignored.
// When set, all localizable fields (title, altText, description, creditLine) will be shown in tabs by language.
{id: 'en', title: 'English', isDefault: true},
{id: 'it', title: 'Italian'},
{id: 'es', title: 'Spanish'},
{id: 'fr', title: 'French'},
{id: 'de', title: 'German'},
{id: 'pt', title: 'Portuguese'},
{id: 'ja', title: 'Japanese'},
{id: 'zh', title: 'Chinese'},
{id: 'ru', title: 'Russian'},
{id: 'ar', title: 'Arabic'}
]
})
],
]
})
```

### Localization (Optional)

You can enable localization support by passing a `locales` array to the plugin config, following the [Sanity recommended scheme](https://www.sanity.io/docs/studio/localization#k4da239411955):

If omitted, localization features will be disabled and the plugin will work as usual.

**Fallback for missing translations:**
The plugin does not apply any automatic fallback for missing translations. You can decide how to handle this in your queries or frontend logic. For example, to show the default language if a translation is missing, you can use GROQ's `coalesce()`:

```
coalesce(altText.it, altText.en)
```

**UI note:**
When `locales` are provided, all localized fields (title, altText, description, creditLine) are grouped by language in tabs. Each tab shows all fields for a single language, making it easy to edit translations for many languages in a compact interface.

This will return the Italian value if present, otherwise English, otherwise French, etc. Adjust the order as needed for your project.

#### Custom Asset Details Component

Custom React component for the asset details form via the plugin config. This allows you to override or extend the default asset details UI.
Expand Down
Loading