npm 包 @beisen-cmps/italent-feed-8 的使用教程

阅读时长 4 分钟读完

前言

@beisen-cmps/italent-feed-8 是领英中国公司出品的一款前端组件库,其所包含的 italent-feed-8 组件主要用于显示人才推荐、招聘职位等内容。本文将对该组件库做详细的介绍和使用教程。

安装

首先,我们需要安装该组件库,打开终端并执行以下命令:

组件调用

安装完成后,我们便可以在项目中使用该组件了。先来看一下该组件的基本用法:

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

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

------ ------- -
  ---- -- -
    ------ -
      ----------- -
        -------- ----------- -- -
          ------ --------------------------
        -
      -
    -
  --
  ----------- -
    ------------
  --
  -------- -
    --------- ----------- -
      -- ---------------
    -
  -
--
---------
展开代码

上述代码中,我们引用了 italentFeed8 组件,并传入了一个名为 feedConfig 的配置参数,其中 getData 函数用于获取数据,我们需要根据实际情况编写获取数据的代码,返回数据格式必须符合以下格式:

-- -------------------- ---- -------
-
  -- ----
  ----------------- --
  
  -- ---
  ----------- ---
  
  -- ----
  ------ --
-
展开代码

props 参数

在使用 @beisen-cmps/italent-feed-8 组件时可以传入以下 props 参数:

config

  • 类型:Object
  • 必填:是
  • 描述:配置参数对象

config.getData

  • 类型:Function
  • 必填:是
  • 描述:用于获取组件需要的数据,函数接收一个 pageIndex 参数,返回 Promise 类型的数据

config.feeds

  • 类型:Array
  • 必填:否
  • 描述:用于传入初始化数据,数组中每一个元素即为一条数据,数据格式与 getData 返回的数据格式一致

skeleton

  • 类型:Boolean
  • 必填:否
  • 默认值:false
  • 描述:是否显示 Skeleton 占位图,当组件初始化时,如果 config.feeds 为空时,将显示 skeleton 占位图

mode

  • 类型:String
  • 必填:否
  • 默认值:'normal'
  • 描述:显示模式,正常模式(normal)和超级模式(super)

itemWrapStyle

  • 类型:Object
  • 必填:否
  • 描述:数据项外部样式

itemProps

  • 类型:Object
  • 必填:否
  • 描述:数据项 props 参数

avatarProps

  • 类型:Object
  • 必填:否
  • 描述:头像 props 参数

jobTagProps

  • 类型:Object
  • 必填:否
  • 描述:职位标签 props 参数

levelProps

  • 类型:Object
  • 必填:否
  • 描述:等级 props 参数

resumeTagProps

  • 类型:Object
  • 必填:否
  • 描述:简历标签 props 参数

labelProps

  • 类型:Object
  • 必填:否
  • 描述:标签 props 参数

总结

通过本文,我们了解了 npm 包 @beisen-cmps/italent-feed-8 的使用方法,以及该组件所包含的 props 参数。希望本文对大家开发前端组件时有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5e68417ac23868a429bccdd8