@netlify/sdk--ui-react

A React-based toolkit for building UI extensions on top of the Netlify platform.

Documentation

See the Netlify SDK documentation for more information.

Installation

Consuming this package directly is not supported; you should instead consume this library via the @netlify/sdk package, which exposes a stable interface over this package.

If you know what you're doing, you can install this module via your JavaScript package manager of choice.

For example:

$ npm install @netlify/sdk--ui-react
$ pnpm add @netlify/sdk--ui-react
$ yarn add @netlify/sdk--ui-react

Development

This package isn't yet published to npm, so you'll need to use a linking workflow to use it when developing locally.

# In @netlify/sdk/packages/sdk--ui-react:
pnpm link -g

# In your extension/wherever you're consuming this package:
pnpm link -g @netlify/sdk--ui-react

If you're consuming this netlify-react-ui (which uses yarn rather than pnpm), you'll need to set up a link using Yarn, too:

# In @netlify/sdk/packages/sdk--ui-react:
# (The COREPACK variable is necessary if you've installed pnpm/yarn via corepack and harmless otherwise)
$ COREPACK_ENABLE_STRICT=0 yarn link --disable-pnp

# Wherever you're consuming this package:
yarn link @netlify/sdk--ui-react

If Yarn gives you grief related related to a workspace:* resolver in this package's package.json, try changing it to a file: resolver.