【山竹记账前端-react】23.封装表单组件(下)


大纲链接 §

[toc]


1. 新页面:编辑标签 ⇧

搭建基本文件框架 ⇧

路由 @/route/routes.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
// import ...
import { TagEditPage } from '@/pages/TagEditPage'
import type { RouteObject } from 'react-router-dom'

export const routes: RouteObject[] = [
  { path: '/', element: <Root /> },
  welcomeRouter,
  { path: '/home', element: <Home title="首页" /> },
  { path: '/sign_in', element: <SignInPage /> },
  { path: '/items', element: <ItemsPage /> },
  { path: '/items/create', element: <ItemCreatePage /> },
  { path: '/tags/create', element: <TagCreatePage /> },
  { path: '/tags/edit/:id', element: <TagEditPage /> },
  { path: '/statistics', element: <div>统计图表</div> },
  { path: '/export', element: <div>敬请期待</div> },
  { path: '/notify', element: <div>敬请期待</div> },
  { path: '/tech_stack', element: <div>敬请期待</div> },
]

@/pages/TagEditPage.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { GradientBanner } from '@/components/GradientBanner'
import { SvgIcon } from '@/components/SvgIcon'
import { TopNav } from '@/components/TopNav'
import { cn } from 'cn'

interface Props {
  className?: string
}

export const TagsForm: React.FC<Props> = ({ className }) => {
  const Icon = <SvgIcon name="back-arrow" className="size-[24px]" />
  return (
    <div className={cn('container w-screen h-screen relative', className)}>
      <GradientBanner>
        <TopNav title="标签详情" icon={Icon} />
      </GradientBanner>

      {/* TODO: 封装表单 */}
    </div>
  )
}

创建通用表单状态 createFormStore ⇧

目前标签表单-创建/编辑的公共逻辑

  • 入参数据:lastData、lastError
  • 表单操作:更新数据、清除错误提示、验证数据、提交数据

对比现有的表单状态文件 useTagCreateStore.ts 和 useSignInStore.ts,有公共逻辑可以提取为工厂函数,创建独立的表单验证相关的状态文件

  • 数据:data、error、
  • 操作:setData、setError、clearError、revalidateFormItems

封装通用表单状态 @/stores/createFormStore.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
import type { JSONValue } from '@/global'
import { create } from 'zustand'
import { formValidate, type FormErrorsType, type FormRules } from '@/lib/validator/formValidate'

export type FormStore<TData, TForm extends JSONValue> = {
  data: TData
  error: FormErrorsType<TForm>
  setData: (data: Partial<TData>) => void
  setError: (error: Partial<FormErrorsType<TForm>>) => void
  clearError: (key?: keyof TForm) => void
  revalidateFormItems: <T extends TForm>(
    formData: Partial<T>,
    formRules: FormRules<T>,
    lastError?: FormErrorsType<T>
  ) => void
}

export function createFormStore<TData, TForm extends JSONValue>(
  options: {
    genInitData: () => TData
    genInitError: () => FormErrorsType<TForm>
  }
) {
  return create<FormStore<TData, TForm>>()((set, get) => ({
    data: options.genInitData(),
    error: options.genInitError(),
    setData: (data: Partial<TData>) => {
      set((state) => ({
        ...state,
        data: { ...state.data, ...data },
      }))
    },
    setError: (error: Partial<FormErrorsType<TForm>>) => {
      set((state) => ({
        ...state,
        error: { ...state.error, ...error },
      }))
    },
    clearError: (key?: keyof TForm) => {
      set((state) => ({
        ...state,
        error: key ? { ...state.error, [key]: [] } : options.genInitError(),
      }))
    },
    revalidateFormItems: <T extends TForm>(
      formData: Partial<T>,
      formRules: FormRules<T>,
      lastError?: FormErrorsType<T>
    ) => {
      get().clearError()
      const keys = Object.keys(formData ?? {})
      const validatingRules = formRules.filter((rule) => keys.includes(String(rule.key)))
      const formError = formValidate(formData, validatingRules)
      get().setError({ ...lastError, ...formError } as Partial<FormErrorsType<TForm>>)
    },
  }))
}

改造 @/stores/useSignInStore.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
import { createFormStore } from './createFormStore'

export type SignInFormData = { email: string; code: string }

const genInitData = () => ({ email: '', code: '' })
const genInitError = () => ({ email: [], code: [] })

export const useSignInStore = createFormStore<SignInFormData, SignInFormData>({
  genInitData,
  genInitError,
})

改造 @/stores/useTagCreateStore.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import type { PickedTag, TabKind } from '@/global'
import type { FormErrorsType } from '@/lib/validator/formValidate'
import { createFormStore } from './createFormStore'

type FormSubmitData = PickedTag & { kind?: TabKind }
type FormValidateData = PickedTag

const genInitData = (): FormSubmitData => ({
  kind: 'expenses',
  name: '',
  sign: '',
})

const genInitError = (): FormErrorsType<FormValidateData> => ({ name: [], sign: [] })

export const useTagCreateStore = createFormStore<FormSubmitData, FormValidateData>({
  genInitData,
  genInitError,
})

新建 @/stores/useTagEditStore.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import type { PickedTag, TabKind } from '@/global'
import type { FormErrorsType } from '@/lib/validator/formValidate'
import { createFormStore } from './createFormStore'

type FormSubmitData = PickedTag & { kind?: TabKind; id: number }
type FormValidateData = PickedTag

const genInitData = (): FormSubmitData => ({
  id: 0,
  kind: 'expenses',
  name: '',
  sign: '',
})

const genInitError = (): FormErrorsType<FormValidateData> => ({ name: [], sign: [] })

export const useTagEditStore = createFormStore<FormSubmitData, FormValidateData>({
  genInitData,
  genInitError,
})

封装标签页通用表单组件 TagForm.tsx 自定义状态钩子要点 ⇧

@/modules/tags/TagForm.tsx

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// import...
import { useTagCreateStore } from '@/stores/useTagCreateStore'
import { useTagEditStore } from '@/stores/useTagEditStore'

interface Props {
  className?: string
  mode: 'create' | 'edit'
  submitButtonText?: string
}

const tagRules: FormRules<PickedTag> = [
  { key: 'name', type: 'required', required: true, message: '标签名称不能为空' },
  { key: 'name', type: 'length', min: 1, max: 4, message: '最多输入4个字符' },
  { key: 'sign', type: 'required', required: true, message: '符号不能为空' },
] as const

export const TagForm: React.FC<Props> = ({
  className,
  mode = 'create',
  submitButtonText = '确定',
}) => {
  const create = useTagCreateStore()
  const edit = useTagEditStore()
  const {
    data: lastData,
    error: lastError,
    setData,
    clearError,
    revalidateFormItems,
  } = mode === 'edit' ? edit : create

  const onChangeTagName = (name: string) => {
    setData({
      ...lastData,
      name,
    })
  }
  const onBlurTagName = () => {
    revalidateFormItems<PickedTag>({ name: lastData.name }, tagRules, lastError)
  }
  const onFocusTagName = () => {
    clearError('name')
  }

  const onChangeTagSign = (sign: string) => {
    setData({
      sign,
    })
  }

  const onBlurTagSign = () => {
    revalidateFormItems<PickedTag>({ sign: lastData.sign }, tagRules, lastError)
  }
  const onFocusTagSign = () => {
    clearError('sign')
  }

  const onSubmit: FormEventHandler<HTMLFormElement> = async (e) => {
    e.preventDefault()
    revalidateFormItems<PickedTag>(lastData, tagRules, lastError)
    // 注意过期的闭包 lastData、lastError 都是闭包,不能直接使用,需要用 useSignInStore.getState() 获取最新状态
    const activeStore = mode === 'edit' ? useTagEditStore : useTagCreateStore
    const freshError = activeStore.getState().error
    const freshData = activeStore.getState().data
    if (!hasError(freshError)) {
      console.log('onSubmit_______________________')
      console.log('%c⧭ lastData', 'color: #40fff2', lastData)
      console.log('%c⧭ freshData', 'color: #40fff2', freshData)
      console.log('%c⧭ lastError', 'color: #40fff2', lastError)
      console.log('%c⧭ freshError', 'color: #40fff2', freshError)
      // console.log('%c⧭ TODO: 发送创建标签请求', 'color: #40fff2', formData)
      console.log('_______________________onSubmit')
    }
  }

  return (
    <form onSubmit={onSubmit} className={cn('form-sc', className)}>
      <FormItem
        formItemType="input"
        formItemTypeProps={{
          inputType: 'text',
          label: '标签名',
          labelFor: 'tag-name',
          placeholder: '请输入标签名称',
          ifUseLabelTag: true,
          errorHint: lastError?.name && lastError.name.join(','),
          value: lastData.name,
          onChange: onChangeTagName,
          onBlur: onBlurTagName,
          onFocus: onFocusTagName,
        }}
      />

      <FormItem
        formItemType="emoji"
        formItemTypeProps={{
          errorHint: lastError?.sign && lastError.sign.join(','),
          value: lastData.sign,
          onChange: onChangeTagSign,
          onBlur: onBlurTagSign,
          onFocus: onFocusTagSign,
        }}
      />

      <p className="form-item-sc text-center">记账时长按,即可进行编辑</p>

      <div className="form-item-sc">
        <button type="submit" className="primary-btn">
          {submitButtonText}
        </button>
      </div>

      {mode === 'edit' && (
        <div className="form-item-sc mb-32px">
          <button type="submit" className="primary-btn bg-[var(--delete-button-bg)]">
            删除标签
          </button>
        </div>
      )}
    </form>
  )
}
  • useTagCreateStore、useTagEditStore 必须以静态形式提前声明,不可放到条件判断中
    • ❌ const store = mode === 'edit' ? useTagEditStore() : useTagCreateStore() 会报钩子使用错误
    • ✅ const create = useTagCreateStore(); const edit = useTagEditStore(); cosnt store = mode === 'edit' ? edit : create;

改造 @/pages/TagCreatePage.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
import { useEffect } from 'react'
import { cn } from 'cn'
import { GradientBanner } from '@/components/GradientBanner'
import { TopNav } from '@/components/TopNav'
import { SvgIcon } from '@/components/SvgIcon'
import { useTagCreateStore } from '@/stores/useTagCreateStore'
import { useSearchParams } from 'react-router-dom'
import { TagForm } from '@/modules/tags/TagForm'

interface Props {
  className?: string
}

export const TagCreatePage: React.FC<Props> = ({ className }) => {
  const Icon = <SvgIcon name="back-arrow" className="size-[24px]" />
  const [searchParams] = useSearchParams()
  const { data, setData } = useTagCreateStore()

  useEffect(() => {
    const kind = searchParams.get('kind')
    if (!kind) {
      throw new Error('kind is required')
    }
    if (kind !== 'incomes' && kind !== 'expenses') {
      throw new Error('kind is invalid')
    }
    setData({ kind })
    console.log('TagCreatePage_______________________')
    console.log('%c⧭', 'color: #86bf60', data)
    console.log('%c⧭', 'color: #cc7033', kind)
    console.log('_______________________TagCreatePage')
  }, [searchParams])

  return (
    <div className={cn('container w-screen h-screen relative', className)}>
      <GradientBanner>
        <TopNav title="新建标签" icon={Icon} />
      </GradientBanner>

      <TagForm mode="create" submitButtonText="创建" />
    </div>
  )
}

改造 @/pages/TagEditPage.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
import { GradientBanner } from '@/components/GradientBanner'
import { SvgIcon } from '@/components/SvgIcon'
import { TopNav } from '@/components/TopNav'
import { TagForm } from '@/modules/tags/TagForm'
import { useTagEditStore } from '@/stores/useTagEditStore'
import { cn } from 'cn'
import { useEffect } from 'react'
import { useParams } from 'react-router-dom'

interface Props {
  className?: string
}

export const TagEditPage: React.FC<Props> = ({ className }) => {
  const Icon = <SvgIcon name="back-arrow" className="size-[24px]" />
  const params = useParams()
  const { data, setData } = useTagEditStore()

  useEffect(() => {
    const id = Number(params.id)
    if (!id) {
      throw new Error('id is required')
    }
    // TODO: 接口获取标签详情数据
    setData({ id, kind: 'incomes', name: '走水', sign: '🚶' })
    console.log('TagEditPage_______________________')
    console.log('%c⧭ params', 'color: #9c87f0', params)
    console.log('%c⧭ data', 'color: #5277cc', data)
    console.log('_______________________TagEditPage')
  }, [params])

  return (
    <div className={cn('container w-screen h-screen relative', className)}>
      <GradientBanner>
        <TopNav title="标签详情" icon={Icon} />
      </GradientBanner>

      <TagForm mode="edit" submitButtonText="保存" />
    </div>
  )
}

2.使用 useEmojiStore 状态重构 emoji 相关组件状态管理(上) ⇧

通过 getEmojiById 根据 emojiId 重新设置 emoji 状态 ⇧

@/lib/helpers/getEmojiById.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import { emojiTopicList, type EmojiMainTopic } from '@/lib/const/emojiTopicList'
import { safeEmojiList, type EmojiTopic } from '@/lib/const/safeEmojiList'

type EmojiItem = {
  id: number
  emoji: string
  hint: string
  topic: EmojiTopic['topic']
  mainTopic: EmojiMainTopic
}

export const getEmojiById = (id: number): EmojiItem => {
  const emojiItem = safeEmojiList.find((item) => {
    return item.emoji_list.find((emoji) => emoji.index === id)
  })

  if (!emojiItem) {
    throw new Error('emoji not found by getEmojiById')
  }

  const emoji = emojiItem?.emoji_list.find((emoji) => emoji.index === id)?.unicode ?? ''
  const hint = emojiItem?.emoji_list.find((emoji) => emoji.index === id)?.hint ?? ''
  const topic = emojiItem?.topic
  const mainTopic = emojiTopicList.find((item) =>
    (item.topics as readonly string[]).includes(topic)
  )?.mainTopic

  if (!mainTopic) {
    throw new Error('mainTopic not found by getEmojiById')
  }

  return {
    id,
    emoji,
    hint,
    topic,
    mainTopic,
  }
}
  • 根据 safeEmojiList 中各个 emoji 的 index 属性返回选中的 emojiItem 信息
  • 可以直接将这个数据属性渲染到页面上,避免各层次的组件传参

创建 useEmojiStore 状态 ⇧

@/stores/useEmojiStore.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import type { EmojiMainTopic } from '@/lib/const/emojiTopicList'
import type { EmojiTopic } from '@/lib/const/safeEmojiList'
import { create } from 'zustand'
import { withDevtoolsBridge } from 'zustand-devtools-bridge'

interface EmojiState {
  id?: number | null
  emoji?: string
  hint?: string
  topic?: EmojiTopic['topic'] | ''
  mainTopic?: EmojiMainTopic
}

interface EmojiActions {
  setEmoji: (emojiState: EmojiState) => void
  reset: () => void
}

const initialEmojiState: EmojiState = {
  id: null,
  emoji: '',
  hint: '',
  topic: '',
  mainTopic: '表情',
}

export const useEmojiStore = create<EmojiState & EmojiActions>()(
  withDevtoolsBridge(
    (set, _get) => ({
      ...initialEmojiState,
      setEmoji: (emojiState: Partial<EmojiState>) => set((state) => ({ ...state, ...emojiState })),
      reset: () => set(initialEmojiState),
    }),
    {
      name: 'emoji',
      enabled: import.meta.env.DEV,
    }
  )
)
  • 使用 zustand-devtools-bridge 浏览器插件配合插件库方便在控制台调试,实时查看状态数据
  • 主要需要的数据 id: emoji_id、emoji、hint、topic、mainTopic
  • 模拟从请开启中获取到 sign_id 后,就可以通过 getEmojiById 获取 emojiItem 数据
  • 再更新到此状态中,以供 emoji 各个相关组件使用

emoji 相关组件数据流转链条 ⇧

  • TagEditPage
    • TODO: 根据路由路径参数id 请求接口获取标签详情数据;
    • 将模拟数据更新到 useTagEditStore 和 useEmojiStore 状态
    • 渲染 TagForm mode="edit"
    • 根据 mode 使用 useTagEditStore 状态设置初始值
    • 绑定输入输出数据,同步操作更新状态 useTagEditStore
    • 验证表单数据
    • TODO: 提交逻辑
    • 渲染 FormItem formItemType="emoji"
      • 根据 formItemType 判断渲染 InputEmoji 组件并透传参数
      • 收窄约束参数类型 {...(formItemTypeProps as FormItemTypeProps<'emoji'>)}
      • 渲染 InputEmoji
      • 通过 useEmojiStore 获取数据渲染到组件部分结构中
      • 监听状态中 emojiId、emoji、mainTopic 和 外部参数 value 更新 emojiItem 状态
      • 调用传参 onChange 更新父组件参数
      • 透传参数 onBlur、onFocus
      • 渲染 EmojiSelector
        • 透传参数 onBlur、onFocus
        • 渲染 EmojiMainTopicNav
        • 遍历渲染主题列表
        • 负责切换表情主题逻辑,重置并更新主题状态
        • 监听主题数据,切换时重置并更新主题状态
        • 绑定事件 onBlur、onFocus 传参
        • 渲染 EmojiUnicodeList
        • 遍历渲染主题相关表情列表
        • 负责切换表情逻辑,更新表情相关状态
        • 监听表情 emoji、emojiHint 数据,更新表情相关状态
        • 绑定事件 onBlur、onFocus 传参
  • TagCreatePage 与编辑组件相似,只是初始数据来源不同,模式、类型、状态判断不同
    • TagForm mode="create"
    • FormItem formItemType="emoji"
      • InputEmoji
      • EmojiSelector
        • EmojiMainTopicNav
        • EmojiUnicodeList

使用 useEmojiStore 状态重构 emoji 相关组件状态管理(下) ⇧

  • 移除组件内原来 props 传参数与据回调,统一改为由 store 驱动
  • 通过 restProps 透传至 EmojiSelector 内部各元素

改造状态文件 useTagEditStore 和 useTagCreateStore ⇧

改造 @/stores/createFormStore.ts 添加调试中间件,并配置 mode 属性

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
import type { JSONValue } from '@/global'
import { create } from 'zustand'
import { formValidate, type FormErrorsType, type FormRules } from '@/lib/validator/formValidate'
import { withDevtoolsBridge } from 'zustand-devtools-bridge'

export type FormStore<TData, TForm extends JSONValue> = {
  data: TData
  error: FormErrorsType<TForm>
  setData: (data: Partial<TData>) => void
  setError: (error: Partial<FormErrorsType<TForm>>) => void
  clearError: (key?: keyof TForm) => void
  revalidateFormItems: <T extends TForm>(
    formData: Partial<T>,
    formRules: FormRules<T>,
    lastError?: FormErrorsType<T>
  ) => void
}

export function createFormStore<TData, TForm extends JSONValue>(options: {
  genInitData: () => TData
  genInitError: () => FormErrorsType<TForm>
  mode: 'create' | 'edit'
}) {
  return create<FormStore<TData, TForm>>()(
    withDevtoolsBridge(
      (set, get) => ({
        data: options.genInitData(),
        error: options.genInitError(),
        setData: (data: Partial<TData>) => {/* ... */},
        setError: (error: Partial<FormErrorsType<TForm>>) => /* ... */},
        clearError: (key?: keyof TForm) => {/* ... */},
        revalidateFormItems: <T extends TForm>(
          formData: Partial<T>,
          formRules: FormRules<T>,
          lastError?: FormErrorsType<T>
        ) => {/* ... */},
      }),
      options.mode
        ? {
            name: `tag-${options.mode}-form`,
            enabled: import.meta.env.DEV,
          }
        : { enabled: false }
    )
  )
}
  • 仅在开发模式启用 enabled: import.meta.env.DEV
  • 根据模式名称配置 name 属性 name:tag-${options.mode}-form`

@/stores/useTagEditStore.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
// import...

type FormSubmitData = PickedTag & { kind?: TabKind; id: number; sign_id: number }
type FormValidateData = PickedTag

const genInitData = (): FormSubmitData => ({
  id: 0,
  kind: 'expenses',
  name: '',
  sign_id: 0,
  sign: '',
})

const genInitError = (): FormErrorsType<FormValidateData> => ({ name: [], sign: [] })

export const useTagEditStore = createFormStore<FormSubmitData, FormValidateData>({
  genInitData,
  genInitError,
  mode: 'edit',
})
  • 添加了 sign_id 字段,之后可使用 getEmojiById 获取 emojiItem 数据,同步更新状态

@/stores/useTagCreateStore.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
// import...

const genInitData = (): FormSubmitData => ({
  kind: 'expenses',
  name: '',
  sign_id: 0,
  sign: '',
})

const genInitError = (): FormErrorsType<FormValidateData> => ({ name: [], sign: [] })

export const useTagCreateStore = createFormStore<FormSubmitData, FormValidateData>({
  genInitData,
  genInitError,
  mode: 'create',
})
  • 添加了 sign_id 字段,用以简化获取 emojiItem 数据,同步更新状态

改造页面组件 TagEditPage.tsx ⇧

@/pages/TagEditPage.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// import...

export const TagEditPage: React.FC<Props> = ({ className }) => {
  const Icon = <SvgIcon name="back-arrow" className="size-[24px]" />
  const params = useParams()
  const { setData } = useTagEditStore()
  const { setEmoji } = useEmojiStore()

  useEffect(() => {
    const id = Number(params.id)
    if (!id) {
      throw new Error('id is required')
    }
    // TODO: 根据id 请求接口获取标签详情数据
    const mockData = {
      id,
      kind: 'incomes',
      name: '走水',
      sign: '\u{1F6B6}',
      sign_id: 415,
    } as const
    const emojiItem = getEmojiById(415)
    setData(mockData)
    setEmoji(emojiItem)

    console.log('TagEditPage useEffect_______________________')
    console.log('%c⧭ params', 'color: #9c87f0', params)
    console.log('%c⧭ emojiItem', 'color: #733d00', emojiItem)
    console.log('_______________________TagEditPage useEffect')
  }, [params, setEmoji, setData])

  return (
    <div className={cn('container w-screen h-screen relative', className)}>
      <GradientBanner>
        <TopNav title="标签详情" icon={Icon} />
      </GradientBanner>

      <TagForm mode="edit" submitButtonText="保存" />
    </div>
  )
}
  • TODO: 根据id 请求接口获取标签详情数据

改造 TagForm ⇧

@/modules/tags/TagForm.tsx

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
// import...

interface Props {
  className?: string
  mode: 'create' | 'edit'
  submitButtonText?: string
}

const tagRules: FormRules<PickedTag> = [/* ... */] as const

export const TagForm: React.FC<Props> = ({
  className,
  mode = 'create',
  submitButtonText = '确定',
}) => {
  const create = useTagCreateStore()
  const edit = useTagEditStore()
  const {
    data: lastData,
    error: lastError,
    setData,
    clearError,
    revalidateFormItems,
  } = mode === 'edit' ? edit : create

  const onChangeTagName = (name: string) => {
    setData({
      ...lastData,
      name,
    })
  }
  const onBlurTagName = () => {
    revalidateFormItems<PickedTag>({ name: lastData.name }, tagRules, lastError)
  }
  const onFocusTagName = () => {
    clearError('name')
  }

  const onChangeTagSign = (sign_id: number, sign: string) => {
    setData({
      sign_id,
      sign,
    })
  }

  const onBlurTagSign = () => {
    revalidateFormItems<PickedTag>({ sign: lastData.sign }, tagRules, lastError)
  }
  const onFocusTagSign = () => {
    clearError('sign')
  }

  const onSubmit: FormEventHandler<HTMLFormElement> = async (e) => {
    e.preventDefault()
    revalidateFormItems<PickedTag>(lastData, tagRules, lastError)
    // 注意过期的闭包 lastData、lastError 都是闭包,不能直接使用,需要用 useSignInStore.getState() 获取最新状态
    const activeStore = mode === 'edit' ? useTagEditStore : useTagCreateStore
    const freshError = activeStore.getState().error
    const freshData = activeStore.getState().data
    if (!hasError(freshError)) {
      console.log('onSubmit_______________________')
      console.log('%c⧭ lastData', 'color: #40fff2', lastData)
      console.log('%c⧭ freshData', 'color: #40fff2', freshData)
      console.log('%c⧭ lastError', 'color: #40fff2', lastError)
      console.log('%c⧭ freshError', 'color: #40fff2', freshError)
      // console.log('%c⧭ TODO: 发送创建标签请求', 'color: #40fff2', formData)
      console.log('_______________________onSubmit')
    }
  }

  return (
    <form onSubmit={onSubmit} className={cn('form-sc', className)}>
      <FormItem
        formItemType="input"
        formItemTypeProps={{
          inputType: 'text',
          label: '标签名',
          labelFor: 'tag-name',
          placeholder: '请输入标签名称',
          ifUseLabelTag: true,
          errorHint: lastError?.name && lastError.name.join(','),
          value: lastData.name,
          onChange: onChangeTagName,
          onBlur: onBlurTagName,
          onFocus: onFocusTagName,
        }}
      />

      <FormItem
        formItemType="emoji"
        formItemTypeProps={{
          errorHint: lastError?.sign && lastError.sign.join(','),
          value: lastData.sign_id,
          onChange: onChangeTagSign,
          onBlur: onBlurTagSign,
          onFocus: onFocusTagSign,
        }}
      />

      <p className="form-item-sc text-center">记账时长按,即可进行编辑</p>

      <div className="form-item-sc">
        <button type="submit" className="primary-btn">
          {submitButtonText}
        </button>
      </div>

      {/* TODO: 实现删除标签请求 */}
      {mode === 'edit' && (
        <div className="form-item-sc mb-32px">
          <button type="submit" className="primary-btn bg-[var(--delete-button-bg)]">
            删除标签
          </button>
        </div>
      )}
    </form>
  )
}
  • 主要和表单相关状态交互
  • onSubmit 中收集表单数据,执行验证逻辑
  • TODO: 发送创建标签请求
  • TODO: 实现删除标签请求
  • 对于 FormItem 主要数据交互:value 和 onChange
    • onBlur 触发重新验证对应表单项数据
    • onFocus 触发时清楚对应表单项错误提示
    • formItemType 类型判断,影响传参数据类型
    • errorHint 传参错误提示,影响相关样式

改造 FormItem 泛型组件与相关类型声明 ⇧

@/components/form/item/FormItemType.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
export type FormItemType = 'input' | 'emoji' | 'validateCodeSend'
export type InputType = 'text' | 'password' | 'email' | 'number'
export type CommonFormItemTypeProps = {
  label?: string
  labelFor?: string
  ifUseLabelTag?: boolean
  hasLabelColon?: boolean
  placeholder?: string
  errorHint?: string
  hasErrorPlaceholder?: boolean
  value?: string
  onChange?: (value: string) => void
  onBlur?: () => void
  onFocus?: () => void
}

export type FormItemTypeProps<T extends FormItemType> = T extends 'input'
  ? CommonFormItemTypeProps & { type?: 'input'; inputType: InputType }
  : T extends 'emoji'
    ? Omit<CommonFormItemTypeProps, 'value' | 'onChange'> & {
        type?: 'emoji'
        value?: number
        onChange?: (sign_in: number, sign: string) => void
      }
    : T extends 'validateCodeSend'
      ? CommonFormItemTypeProps & { type?: 'validateCodeSend'; onClickSendCode?: () => void }
      : never
  • 注意合并类型别名,避免合并同名属性为 never,需要合并覆盖时使用 Omit 忽略同名属性

@/components/form/item/FormItem.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
import { InputEmoji } from '@/components/form/item/InputEmoji'
import { InputText } from '@/components/form/item/InputText'
import { InputValidateCodeSend } from '@/components/form/item/InputValidateCodeSend'
import type { FormItemType, FormItemTypeProps } from '@/components/form/item/FormItemType.ts'

interface Props<T extends FormItemType> {
  className?: string
  formItemType: T
  formItemTypeProps: FormItemTypeProps<T>
}

export const FormItem = <T extends FormItemType>({
  className,
  formItemType,
  formItemTypeProps,
}: Props<T>) => {
  const renderContent = () => {
    switch (formItemType) {
      case 'input':
        return (
          <InputText {...(formItemTypeProps as FormItemTypeProps<'input'>)} className={className} />
        )
      case 'emoji':
        return (
          <InputEmoji
            {...(formItemTypeProps as FormItemTypeProps<'emoji'>)}
            className={className}
          />
        )
      case 'validateCodeSend':
        return (
          <InputValidateCodeSend
            {...(formItemTypeProps as FormItemTypeProps<'validateCodeSend'>)}
            className={className}
          />
        )
      default:
        return null
    }
  }
  return <>{renderContent()}</>
}
  • TS 在 switch (formItemType) 中不会把泛型 T 缩窄为字面量
  • 因此 formItemTypeProps 仍为联合类型
  • 展开到各具体组件时 value 等属性类型不兼容
  • 在各分支断言为对应字面量类型的 props

InputEmoji ⇧

@/components/form/item/InputEmoji.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
// import...

interface Props {
  className?: string
  hasLabelColon?: boolean
  errorHint?: string
  hasErrorPlaceholder?: boolean
  value?: number
  onChange?: (sign_id: number, sign: string) => void
  onBlur?: () => void
  onFocus?: () => void
}

export const InputEmoji: React.FC<Props> = ({
  className,
  hasLabelColon = true,
  errorHint,
  hasErrorPlaceholder = true,
  value = '',
  onChange,
  ...restProps
}) => {
  const { id: emojiId, emoji, hint, mainTopic, setEmoji } = useEmojiStore()

  useEffect(() => {
    if (!emojiId || !emoji) {
      return
    }
    const emojiItem = getEmojiById(emojiId)
    setEmoji(emojiItem)
    onChange?.(emojiId ?? 0, emoji ?? '')
  }, [emojiId, value, emoji, mainTopic, onChange, setEmoji])

  return (
    <section className={cn('form-item-sc relative', className)}>
      <div className="form-label-sc text-[22px]">
        <span className="text-[16px]">符号 {hasLabelColon ? ':' : ''}</span>
        <span className={cn('text-22px inline-block wag')}>{emoji}</span>
        <span className="text-[16px] animate-rainbow color-[var(--vp-c-brand-next)]">{hint}</span>
      </div>

      <EmojiSelector {...restProps} hasError={!!errorHint} className="form-item-content-sc" />

      {(errorHint || hasErrorPlaceholder) && (
        <span className="form-item-error-sc w-fit buzz">{errorHint ?? <>&nbsp;</>}</span>
      )}
    </section>
  )
}
  • 监听状态数据 id: emojiId、 emoji、 mainTopic,和外部数据传参 value
    • 提前退出逻辑 !emojiId || !emoji
    • 通过 id 获取 emojiItem 数据,更新状态
    • 并且使用外部传参回调函数 onChange 传参数据 emojiId、emoji,更新表单数据
  • 通过 {...restProps} 透传事件 onBlur、onFocus 到子组件 EmojiSelector
  • 不与子组件直接通信,而是和状态 useEmojiStore 通信

EmojiSelector ⇧

@/components/form/item/emoji/EmojiSelector.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
// import...

interface Props {
  className?: string
  hasError?: boolean
  onBlur?: () => void
  onFocus?: () => void
}

export const EmojiSelector: React.FC<Props> = ({ className, hasError, ...restProps }) => {
  const { mainTopic } = useEmojiStore()
  return (
    <div
      className={cn(/* ... */)}>
      <EmojiMainTopicNav {...restProps} />
      <EmojiUnicodeList key={mainTopic} {...restProps} />
    </div>
  )
}
  • 使用 mainTopic 状态标记组件 EmojiUnicodeList 的 key 属性
  • 通过 {...restProps} 透传事件 onBlur、onFocus 到子组件 EmojiMainTopicNav 和 EmojiUnicodeList
  • 不与子组件直接通信,而是和状态 useEmojiStore 通信

EmojiMainTopicNav ⇧

@/components/form/item/emoji/EmojiMainTopicNav.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// import...

interface Props {
  className?: string
  onBlur?: () => void
  onFocus?: () => void
}

export const EmojiMainTopicNav: React.FC<Props> = ({ className, ...restProps }) => {
  const navList = emojiTopicList?.map((topicItem) => topicItem.mainTopic) ?? []
  const { mainTopic = navList?.[0], setEmoji, reset } = useEmojiStore()

  const selectMainTopic = (mainTopic: EmojiMainTopic) => {
    reset()
    setEmoji({ mainTopic })
  }

  useEffect(() => {
    reset()
    setEmoji({ mainTopic })
  }, [mainTopic, setEmoji, reset])

  return (
    <nav className={cn('min-h-35px', className)}>
      <menu
        className={cn(/* ... */)}>
        {navList.map((item, index) => (
          <li
            tabIndex={index}
            key={`${index}_${item}`}
            onClick={() => selectMainTopic(item)}
            {...restProps}
            className={cn(/* ... */)}>
            {item}
          </li>
        ))}
      </menu>
    </nav>
  )
}
  • 用户点击切换,执行 selectMainTopic 逻辑,重置状态,更新 mainTopic 状态
  • 监听 mainTopic 数据变化,重置状态,更新 mainTopic 状态
  • 除了绑定事件 onBlur、onFocus,不与父组件直接通信,而是和状态 useEmojiStore 通信

EmojiUnicodeList ⇧

@/components/form/item/emoji/EmojiUnicodeList.tsx

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
// import...

interface Props {
  className?: string
  onBlur?: () => void
  onFocus?: () => void
}

export const EmojiUnicodeList: React.FC<Props> = ({ className, ...restProps }) => {
  const { mainTopic, emoji, setEmoji } = useEmojiStore()

  const selectedTopicList = useMemo<readonly EmojiSubTopic[]>(/* ... */)
  const selectedFlattedEmojiList = useMemo<EmojiItem[]>(/* ... */)
  const emojiHint = useMemo(/* ... */)

  const switchEmojiUnicode = (unicode: string, id: number) => {
    if (unicode === emoji) {
      return
    }
    const emojiItem = getEmojiById(id)
    setEmoji({
      ...emojiItem,
    })
  }

  useEffect(() => {
    setEmoji({
      emoji,
      hint: emojiHint,
    })
  }, [emoji, emojiHint, setEmoji])

  // ...

  return (
    <ol
      tabIndex={-1}
      className={cn(/* ... */)}>
      {selectedFlattedEmojiList.map(({ index: id, unicode }, index) => (
        <li
          // 设置 tabIndex 让普通元素 li 元素能够接收焦点,触发 onBlur
          tabIndex={index}
          key={`id_${id}_${index}_${unicode}`}
          onClick={() => {
            switchEmojiUnicode(unicode, id)
          }}
          {...restProps}
          className={cn(/* ... */)}>
          {unicode}
        </li>
      ))}
    </ol>
  )
}
  • 用户点击切换,执行 switchEmojiUnicode 逻辑,通过 getEmojiById 获取 emojiItem 更新状态,点击同样emoji不执行逻辑
  • 监听 emoji, emojiHint 变化,更新状态
  • 除了绑定事件 onBlur、onFocus,不与父组件直接通信,而是和状态 useEmojiStore 通信

·未完待续·

参考文章

相关文章


  • 作者: Joel
  • 文章链接:
  • 版权声明
  • 非自由转载-非商用-非衍生-保持署名