Contrib.social

Export "WebformElementWrapper" and other internals

Open on Drupal.org →
Created on 27 November 2023, over 1 year ago
Updated 5 January 2024, over 1 year ago

Problem/Motivation

WebformElementWrapper is not exported to the published NPM package. This makes the first step in the documentation for "Using custom components" incorrect:

// Example custom component
export const WebformDate = ({ element, error }) => {
  return (
    <WebformElementWrapper
      labelFor={element['#title']}
      isRequired={element['#required']}
      settings={null}
      error={error}
    >
      <input
        type="date"
        name={element['#webform_key']}
        min="2022-01-01"
        max="2022-12-31"
      />
    </WebformElementWrapper>
  );
};

The above is not possible, as WebformElementWrapper can not be imported into a custom codebase.

Steps to reproduce

  1. Install the package
  2. Create a custom component for customization (e.g., styling). Follow documentation for "Using custom components"
  3. Notice that WebformElementWrapper cannot be used

Proposed resolution

Export necessary wrappers and internals for extending this project.

✨ Feature request
Status

Needs review

Component

Code

Created by

🇺🇸United States Nuuou Lincoln, NE

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @Nuuou
  • First commit to issue fork.
  • Merge request !73Export wrappers → (Open) created by hooroomoo
  • Status changed to Needs review over 1 year ago
  • Comment over 1 year ago →
    🇺🇸United States hooroomoo
  • Comment over 1 year ago →
    🇺🇸United States Nuuou Lincoln, NE

    While this MR is a good start, I think there's a deeper issue of the lack of internals being exported.
    This makes for extending or replacing elements with your own React components still quite difficult.

    As an example: Say I wanted to create my own WebformDate.tsx file for customizing date fields.
    While I can register my own React component to handle this, I'd immediately lose access to the internal withDefaultValue, withStates, withWrapper, and withAttributes helpers that are used in this package's version of WebformDate.tsx here https://git.drupalcode.org/project/next_webform/-/blob/1.0.x/src/compone....

    It'd be great to enhance customization without losing out on all the other benefits this package is providing!

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024