npm 包 @pluralsight/ps-design-system-filter-react-props 使用教程

随着前端开发的不断发展,我们通常会有一个前端组件库,这样可以提高效率、降低重复工作,减少出错的机会。在组件库中,我们经常使用到许多的 props,但是某些 props 并不需要传递到子组件,这时候我们就需要使用一个轮子 -- @pluralsight/ps-design-system-filter-react-props。

@pluralsight/ps-design-system-filter-react-props

@pluralsight/ps-design-system-filter-react-props是一个能够过滤掉不应该向子组件传递的props的npm包。该npm包由 Pluralsight 设计系统提供,并且集成了 TypeScript 类型定义,可以帮助前端开发工程师更好地管理props。

安装

使用npm或yarn安装@pluralsight/ps-design-system-filter-react-props:

--- ------- ------ ------------------------------------------------

- --

---- --- ------------------------------------------------

使用教程

基本使用

假如你需要使用一个组件,并且不希望子组件接收到某些props,你可以通过以下方式使用该 npm 包:

------ ---------------- ---- ---------------------------------------------------

-------- ------------------ -
 ----- - ------ ----- -------- ------- - - ------------------------
 ------ -
   -- ------- ------ ----- -------
   ---- -------- ------ --------- ---- -- ----------
     ----------------------
   ------
 --
-

这里使用了ES6的析构赋值,其中 color, size, variant 是可以传递到子组件的,而剩下的 rest 参数被过滤掉了。

Props 校验

在 TypeScript 项目中使用了 @pluralsight/ps-design-system-filter-react-props 后,您还可以使用PropsFilter接口来类型校验传递给组件的props。下面的示例代码演示了如何使用:

------ ----------------- -
 -----------
- ---- ---------------------------------------------------

--------- ---------------- ------- ------------------ ----------------- -
  -----------
  ------ -------
  ----- -------
-

-------- ------------------ ----------------- -
  ----- - ------ ----- -------- ------- - - ------------------------
  ------ -
    ---- -------- ------ --------- ---- -- ----------
      ----------------------
    ------
  --
-

通过使用 PropsFilter,我们可以确保我们的自定义 color, size props 能够成功传递到 MyComponent 组件中,而进行了过滤的 props 不能被传递。

结论

@pluralsight/ps-design-system-filter-react-props 提供了一个轻松的方式来过滤React props,使得开发人员不需要担心子组件正在使用的 props,帮助构建更安全的组件。有了此功能,我们可以更加专注于组件的开发,更加有效地利用我们的时间。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5f793f687116197505561b20


猜你喜欢

  • npm 包 @resdir/resource-name 使用教程

    1. 简介 在前端开发中,很多时候我们需要使用其他人开发的模块或者框架,这时候我们需要通过 npm 等包管理器引入这些模块。在这里我们详细介绍一个名为 @resdir/resource-name 的 ...

    4 年前
  • npm 包 @pnpm/manifest-utils 使用教程

    概述 @pnpm/manifest-utils 是一个用于处理 NPM 包清单的工具,它可以方便地获取包依赖关系、版本信息以及包的元数据等内容。这个工具可以帮助前端开发者在开发过程中更好的管理包依赖,...

    4 年前
  • npm 包 @resdir/resource-specifier 使用教程

    简介 npm 包 @resdir/resource-specifier 是一款前端类的工具,用于帮助开发者在编写应用程序时,轻松地引用、识别和管理资源。该工具支持多种资源格式,包括结构化数据、配置文件...

    4 年前
  • NPM 包 @pnpm/remove-bins 使用教程

    前言 在前端开发过程中,我们经常使用 npm (Node Package Manager) 来管理依赖包,而 @pnpm/remove-bins 是一款可以移除依赖包中二进制文件的工具包,可以帮助我们...

    4 年前
  • npm 包 @pnpm/modules-cleaner 使用教程

    什么是 @pnpm/modules-cleaner? @pnpm/modules-cleaner 是一个 npm 包,用于清理项目中未被使用的模块。这对于前端开发人员来说非常有用,因为在项目中引入了大...

    4 年前
  • npm 包 @resdir/version-range 使用教程

    在前端开发工作中,我们常常需要使用 npm 包来进行前端开发、构建和部署。而在这过程中,npm 包版本号的控制也是非常重要的,因为最新版本的 npm 包往往会包含更多且更优秀的功能与修复,同时也可能与...

    4 年前
  • npm 包 @okunishinishi/fixpack 使用教程

    前言 在前端开发中,代码的风格统一非常重要,它能够提升代码的可读性和可维护性。无论是团队协作还是作为独立开发者,规范的代码风格是非常必要的。虽然有许多工具可以帮助我们检查和统一代码风格,但在这里我想介...

    4 年前
  • npm 包 @pnpm/normalize-registries 使用教程

    在前端开发中,使用 npm 包管理工具是必不可少的。而且在使用 npm 包的过程中,我们不可避免的会碰到一些关于包管理的问题。其中一个常见的问题就是:如何管理不同源的包? 通常情况下,我们会使用一个 ...

    4 年前
  • npm 包 @pnpm/parse-wanted-dependency 使用教程

    在前端开发中,使用 npm 包管理是不可避免的一部分。有时候我们需要处理依赖包的版本信息,这时候可以使用 @pnpm/parse-wanted-dependency 这个 npm 包。

    4 年前
  • npm 包 the-component-constants 使用教程

    前言 在前端开发过程中,我们经常需要定义一些常量,例如 UI 设计时确定的一些颜色值、字体大小等。使用常量的好处在于能够方便地维护和修改,避免在代码中写死这些值,增加代码的灵活性和可读性。

    4 年前
  • npm 包 the-body 使用教程

    在前端开发中,获取 HTTP 请求体(body)是一项很重要的任务。然而,由于不同请求的 body 可能是不同的类型(如表单、JSON 等),因此直接处理它们可能会变得非常困难。

    4 年前
  • npm 包 @pnpm/prune-lockfile 使用教程

    前言 随着前端项目的不断发展,越来越多的工具和库不断涌现。为了解决这些依赖包之间的版本问题,Node.js 在包管理方面做出了很大的努力。npm 作为 Node.js 最重要的包管理工具,一直在不断的...

    4 年前
  • npm 包 the-style-util 使用教程

    随着 Web 应用的发展,前端开发工作越来越复杂,需要实现更为精细的界面设计。在 CSS 样式管理中,往往需要对样式进行分类、拆分、组合和继承等操作,以方便管理和维护。

    4 年前
  • npm 包 the-button 使用教程

    在前端开发中,我们经常会使用到各种 npm 包来帮助我们快速开发。其中,一个特别有用的 npm 包就是 the-button。the-button 是一个能够帮助我们快速创建按钮的 npm 包,而且支...

    4 年前
  • npm 包 @pnpm/read-modules-dir 使用教程

    在前端开发中,使用 npm 包管理器是非常常见的一种方式,它能够帮助我们很好地管理项目中的依赖。其中,@pnpm/read-modules-dir 作为一个有趣的 npm 包,可以让我们更加方便地读取...

    4 年前
  • npm 包 the-container 使用教程

    the-container 是一个简单而又实用的 npm 包, 它为前端开发者提供了一种容器模式的思想, 可以有效地简化前端应用程序的设计和实现。 什么是 the-container? the-con...

    4 年前
  • npm 包 @pnpm/write-project-manifest 使用教程

    什么是 @pnpm/write-project-manifest @pnpm/write-project-manifest 是一个 npm 包,它可以将项目的依赖关系转换为一个清单文件(manifes...

    4 年前
  • `@pnpm/read-project-manifest` 使用教程

    @pnpm/read-project-manifest 是一个能够读取 package.json 文件并返回一个 Javascript 对象的 npm 包。这个包特别适合用来自动读取项目中的依赖包列表...

    4 年前
  • npm 包 the-head 使用教程

    前言 在前端开发中,经常会遇到需要在网页 head 标签中插入特定的 meta、link 或 script 标签的需求。而手动添加这些标签既麻烦又容易出错,因此很多前端工程师都会使用一些工具或库来帮助...

    4 年前
  • npm 包 @pnpm/package-is-installable 使用教程

    作为前端开发者,我们经常使用 npm 来管理项目中的各种依赖包。而当我们在编写自己的 npm 包时,如何确保它的依赖包能够被正确地安装呢?这就需要用到 @pnpm/package-is-install...

    4 年前

相关推荐

    暂无文章