README.md

stripes-types

Copyright (C) 2023 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

This is a set of TypeScript typings for the Stripes UI framework.

Use with react-final-form

react-final-form support is currently experimental. Stripes has form fields which can optionally be controlled via react-final-form or left uncontrolled. However, in RFF, FieldRenderProps are defined problematically:

• input and meta are required, whereas Stripes should have them be optional (for non-RFF use), meaning we cannot require them;
• the <Field> definition requires the component to require input and meta, meaning we cannot leave them optional; and
• the props also allow any other prop to be passed through and overwrites their types as any, erasing any specific component typings.

With this current situation, there's not too much we can do to make everyone happy. Therefore, this aspect of the typings is experimental and may change in the future.

Currently, the recommended way to use Stripes components in react-final-form without sacrificing typings is via the render prop or as a child:

import { Field } from 'react-final-form';
import { TextField } from '@folio/stripes/components';

// via render prop
<Field
  name="foo"
  render={({ input, meta }) => (
    <TextField
      input={input}
      meta={meta}
      // other TextField specific props
      label="foo"
      required
    />
  )}
/>

// via children
<Field name="foo">
  {({ input, meta }) => (
    <TextField
      input={input}
      meta={meta}
      // other TextField specific props
      label="foo"
      required
    />
  )}
</Field>