@accessible/use-id 中文文档教程

发布于 4年前 浏览 23 项目主页 更新于 3年前


useId()

捆绑恐惧症 Types 代码覆盖率 构建状态 NPM 版本 麻省理工学院许可证

npm i @accessible/use-id

创建唯一的确定性 ID 以促进 WAI-ARIA 和服务器渲染。 从 @reach/auto-id 分叉。

Quick Start

```jsx和谐 import useId from '@accessible/use-id'

常量组件 = () => { const id = useId() 返回

//
} ```

API

useId(fallbackId?: string | null | 0 | false, prefix?: string): string | undefined

一个钩子,每个组件返回一个唯一但确定的 ID

Arguments

ArgumentTypeDefaultRequired?Description
fallbackIdstring | null | 0 | falseundefinedNoAllows you to provide your own id as a fallback
prefixstring????NoAllows you to provide a prefix for the id to prevent collisions with other auto id libs

Credit

这个库是 @ 的一个分支reach/auto-id

Why fork?

Reach UI 不使用真正的语义版本控制(他们的每个包同时更新版本,不管 对单个包的更改……废话)所以你可能(而且很烦人)很容易得到重复的 包中 auto-id 包的版本。 最后,Reach 库会抛出超级烦人的警告 在 SSR 中,因为它使用 useLayoutEffect。 这个库使用 @react-hook/passive-layout-effect 避免这种情况。

LICENSE

麻省理工学院


useId()

Bundlephobia Types Code coverage Build status NPM Version MIT License

npm i @accessible/use-id

Creates unique deterministic IDs to facilitate WAI-ARIA and server rendering. Forked from @reach/auto-id.

Quick Start

```jsx harmony import useId from '@accessible/use-id'

const Component = () => { const id = useId() return

//
} ```

API

useId(fallbackId?: string | null | 0 | false, prefix?: string): string | undefined

A hook that returns a unique, but deterministic ID once per component

Arguments

ArgumentTypeDefaultRequired?Description
fallbackIdstring | null | 0 | falseundefinedNoAllows you to provide your own id as a fallback
prefixstring????NoAllows you to provide a prefix for the id to prevent collisions with other auto id libs

Credit

This library is a fork of @reach/auto-id

Why fork?

Reach UI doesn't use real semantic versioning (each of their packages updates versions at the same time regardless of changes to individual packages… nonsense) so it's possible (and annoyingly so) that you could easily wind up with duplicate version of the auto-id package in your bundle. Lastly, the Reach library throws super annoying warnings in SSR because it uses useLayoutEffect. This library uses @react-hook/passive-layout-effect to avoid that.

LICENSE

MIT

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文