npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ws-serenity/react-auto-form

v1.2.0

Published

Component for creating forms by js objects

Downloads

27

Readme

Auto-form

Repository

Идея

Для каждого проекта инпуты, используемые в форме выглядят идентично. Отсюда вытекает проблема: шаблонное описание стейта и компонентов для каждой из форм

Компонент был разработан специально для админ-панелей, где размещение компонентов на форме строится по замечательному принципу "чтоб влезло". И все, что нам необходимо - указать уникальные пропсы для каждого из компонентов.

Управлением стейта займется сам компонент в связке с библиотекой react-hook-form.

Important

При описании типов пропса управляемого компонента (который передается в AutoForm.jsx) ОБЯЗАТЕЛЬНО НАСЛЕДОВАНИЕ от AfControllable. Иначе магия работать не будет

Что это за тип такой?

Он обеспечивает интерфейс взаимодействия между инпутом и AutoForm. Чтобы стейт обновлялся, валидация проходила. Обязательность наследования сделана намеренной. Эти пропсы невозможно указать при настройки AutoForm.fields. И это тоже намеренно, чтобы ничего не сломалось

THE Main hero

Форма один раз настраивается для проекта:

// можем сами указывать компоненты, которые будут использоваться в качетсве инпутов. Описываем их тип (text, select) и принимаемые пропсы
type AfJsxConfig = { text: AfControllableTextFieldProps, select: AfControllableSelectProps }

// инпуты мы уже описали, больше передавать их не нужно, теперь нас интересует только все остальные поля
export type MuiAutoFormProps<Dto extends FieldValues> = Omit<AutoFormProps<AfJsxConfig, Dto>, 'jsx'>

export function MuiAutoForm<Dto extends FieldValues>(props: MuiAutoFormProps<Dto>) {
    return <AutoForm<AfJsxConfig, Dto>
              jsx={{
                text: TextField,
                select: Select,
              }}
             {...props}
    />
}

Примеры настройки компонентов

  • <input>
    // Пропсы всех управляемых компонентов наследуются от типа AfControllable, 
    // который обеспечивает совместимость с react-hook-form
    // AfControllable содержит все необходимые поля для управления инпутом. 
    // !!!Эти типы не будут отображаться при указании пропсов в `AutoForm.fields`!!!
    // (и это специально, оно и не надо, чтобы ничего не сломать)
    // 
    // ЭТО НАСЛЕДОВАНИЕ ОБЯЗАТЕЛЬНО
    //
    // также мы наследуемся от пропсов нашего компонента, чтобы мы могли их передавать
    // сами пропсы могут реализовать абсолютно любой интерфейс, для AutoForm это все не важно
    export type AfControllableTextFieldProps = TextFieldProps & AfControllable;
      
    export const TextField = forwardRef((props: AfControllableTextFieldProps, ref: any) => {
        // делаем что хотим с пропсами, это больше не является ответственностью AutoForm
        const { error, ...inputProps } = props;
        return (
            <div className={'text-field'}>
                <MuiTextField {...inputProps} value={props.value} onChange={props.onChange} ref={ref}/>
                {
                    !!error?.message && <Alert severity={'error'}>Error object {error.message}</Alert>
                }
            </div>
        )
    })
  • <AutoForm>
interface NestedDto {
    department: string;
    person: {
        firstName: string;
        secondName: string;
    };
    contacts: {
        phone: string
        email?: string;
    }
}

// переиспользуем настроенную форму с инпутами
function TheForm() {
    return (
        // заранее настроенная форма с компонентами ввода. Настраивается один раз под проект
        <MuiAutoForm<NestedDto>
            // передаем пропсы в хук, управляющий формой
            formConfig = {{
                reValidateMode: 'onChange',
                mode:'onBlur',
                // дефолтные значения
                defaultValue:objectToEditFromApi
            }}
            // кнопки управления формой
            actions={jsLikeActions()}
            fields={{
                // указываем ключи полей, как в react-hook-form как flat-json
                // вложенные поля объединяем через "."
                'person.firstName': {
                    // TypeScript может не подсказывать это свойство!!!
                    // оно совпадает с одним из тех полей, что мы указали AfJsxConfig выше
                    afType: 'text',
                    // пропсы, относящиеся конкретно к этому компоненту   
                    label:'Имя',
                    placeholder:'Введите имя',
                    // валидация и всякая всячина для react-hook-form
                    registerOptions:{ ...requiredValidation, ...nameValidation},
                },
                'person.secondName': {
                    afType: 'text',
                    label: 'Фамилия',
                    registerOptions: { ...requiredValidation, ...nameValidation },
                },
                'contacts.email': {
                    afType: 'text',
                    label: 'Почта',
                    registerOptions:emailValidation,
                },
                // поле не является вложенным, просто поле O.O
                department: {
                    // это будет Select
                    afType: 'select',
                    label:'Отдел',
                    registerOptions:requiredValidation,
                    // опции (<option>), требуемые интерфейсом компонта    
                    options: departmentOptions,
                },
            }}
            // автоматическое размещение компонентов внутри формы, в дальнейшем планируется добавление разных способов размещения компоненттов
            // конкретно для gridProcessor указываются столбцы (внешний массив)
            // а во внутренних массивах указывается количество занимаемого места каждым из компонентов
            layout = {
                // под капотом используется display: grid и grid-template-columns(rows)
                gridProcessor([
                    // разместить 2 компонента равномерно
                    [ 1, 1 ],
                    // растянуть один компонент на все доступное место
                    [ 1 ],
                    // растянуть первы компонент на все доступное место, а второй занимает в 2 раза больше места 
                    [ 1, 2 ],
                ])
            }
            onSubmit = {(value)=>alert(JSON.stringify(value))
            }/>
    )
}

Нестандартные кейсы

Если инпуту (или компоненту actions) требуется доступ ко всему состоянию формы, можно использовать хук useFormContext