0.8.24 • Published 3 months ago

@snack-uikit/stepper v0.8.24

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 months ago

Stepper

Компонент отображения состояния пошагового процесса.

Installation

npm i @snack-uikit/stepper

Changelog

Использование

Компонент принимает массив шагов. В проп children принимает render-колбек, в который отдает сам компонент, методы управления и поля состояния. При вызове метода goNext вызывается валидация текущего шага. Функция валидации принимает индекс текущего шага и должна вернуть результат валидации в Promise. При успешной валдиции компонент переходит на следующий шаг, а при ошибке остается на текущем. При вызове метода goPrev компонент переходит на предыдущий шаг.

const steps = [
  { title: 'Step #1' },
  { title: 'Step #2' },
  { title: 'Step #3' },
  { title: 'Step #4' },
];

// ...

return (
  <Stepper steps={steps} validator={validatorFunction}>
    {({
        stepper, // JSX элемент компонента
        isCompleted, // состояние завершенности всей цепочки
        goNext, // функция перехода к след. шагу
        goPrev, // функция перехода к предыдущему шагу
        setValidator, // функция установки валидатора
      }) => (
      <>
        {stepper}

        <button onClick={() => goPrev()}>go back</button>
        <button onClick={() => goNext()}>go next</button>
      </>
    )}
  </Stepper>
)

Stepper

Props

nametypedefault valuedescription
children*({stepper, ...api}) => ReactElement-Render function. Принимает аргументы: stepper - JSX-элемент степпера, goNext(stepIndex?: number) - перейти на след. шаг, goPrev(stepIndex?: number) - перейти на пред. шаг, resetValidation - сбросить состояние валидации для текущего шага, setValidator переопределяет функцию-валидатор, которая принимает в параметры индекс текущего шага и индекс нового, isCompleted - окончен ли процесс, currentStepIndex - индекс текущего шага, stepCount - кол-во шагов.
steps*StepData[]-Массив шагов
defaultCurrentStepIndexnumber-Индекс текущего шага по-дефолту
validatorStepsValidator-Валидатор шагов. Выполняется при смене шага. Принимает первым аргументом индекс текущего, вторым - индекс нового шага.
classNamestring-CSS-класс
onChangeCurrentStep(newValue: number, prevValue: number) => void-Колбек смены текущего степа
onCompleteChange(isCompleted: boolean) => void-Колбек изменения завершенности
0.8.9

8 months ago

0.8.8

8 months ago

0.8.5

9 months ago

0.8.4

9 months ago

0.8.7

8 months ago

0.8.6

9 months ago

0.8.3

10 months ago

0.8.2

10 months ago

0.8.23

4 months ago

0.8.22

6 months ago

0.8.24

4 months ago

0.8.21

6 months ago

0.8.20

6 months ago

0.8.12

7 months ago

0.8.11

7 months ago

0.8.14

6 months ago

0.8.13

7 months ago

0.8.10

7 months ago

0.8.19

6 months ago

0.8.16

6 months ago

0.8.15

6 months ago

0.8.18

6 months ago

0.8.17

6 months ago

0.7.0

10 months ago

0.8.1

10 months ago

0.8.0

10 months ago

0.6.14

11 months ago

0.6.13

11 months ago

0.6.7

1 year ago

0.6.6

1 year ago

0.6.9

1 year ago

0.6.8

1 year ago

0.6.10

1 year ago

0.6.12

11 months ago

0.6.11

12 months ago

0.6.5

1 year ago

0.6.4

1 year ago

0.6.3

1 year ago

0.6.2

1 year ago

0.6.1

1 year ago

0.6.0

1 year ago

0.5.9

1 year ago

0.5.8

1 year ago

0.5.7

2 years ago

0.5.6

2 years ago

0.5.5

2 years ago

0.5.4

2 years ago

0.5.3

2 years ago

0.5.2

2 years ago

0.5.1

2 years ago

0.5.0

2 years ago

0.4.3

2 years ago

0.4.2

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago