npm 包 ngx-medium-widget 使用教程

介绍

ngx-medium-widget 是开发者通过它能够很轻松地将 Medium 的文章嵌入到自己的应用程序中的一个开源 Angular 库。

安装

安装该 Library 最简单的方法是通过 npm 进行。您可以使用以下命令:

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

使用

在 NgModule 中导入 MediumModule

为了使用 MediumModule,您需要首先导入 MediumModule 到您的 NgModule 中。以下是如何在您的 AppModule 中导入 MediumModule。

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

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

在组件中使用

接下来,在您的组件中使用 MediumWidget:

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

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

在上述示例中,创建一个名为 MyComponent 的组件,声明了一个 MediumWidgetOptions 的配置项对象,该对象具有一个 url 属性。然后在组件的 template 中将 options 对象传递给 MediumWidget。

配置选项

该 ngx-medium-widget 库有许多配置项,以下为一些常用的选项。

配置项 数据类型 描述
url {string} medium 作者的 url (必选项)
recommend {boolean} 是否在嵌入的文章下显示推荐文章。默认为 true
latestLimit {number} 显示最近的条目限制
limit {number} 显示文章的条目限制。默认为 10
maxHeight {number} Widget 的最大高度(需要以像素为单位)。默认为 null,表示没有最大高度限制。

示例代码

以下是一个完整示例代码:

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

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

该示例中,我们定义了一个名为 MyComponent 的组件,并导入了 MediumWidgetOptions 对象。然后,我们在模板中定义了一个 MediumWidget,使用了 options 变量作为其输入参数。 options 对象具有以下属性:

  1. url - 表示 Medium 作者的 url
  2. recommend - 表示是否在文章下方显示推荐阅读。默认为 true
  3. latestLimit - 表示显示最近文章的数量。默认为 3
  4. limit - 表示限制显示多少篇文章。默认为 10
  5. maxHeight - 表示 Widget 的最大高度(以像素为单位)。默认为 null,表示没有最大高度限制。

这里我们将 MediumWidget 的高度限制为 500px,文章数量限制为 5,同时关闭了推荐文章和最近文章这两种功能。

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


猜你喜欢

  • npm 包 xrosy-command 使用教程

    Xrosy-Command 是一款前端开发中常用的命令行工具,可以快速生成模板、代码片段等,并且支持自定义模板。在本篇文章中,我们将学习如何使用 Xrosy-Command。

    4 年前
  • npm 包 collect-mutations 使用教程

    在前端开发中,经常需要对页面上的 DOM 元素做一些操作,比如增删改查等。collect-mutations 是一个方便的 npm 包,它可以收集 DOM 元素的增删改操作,并以 JSON 的形式输出...

    4 年前
  • npm 包 Now-App-CLI 使用教程

    介绍 Now-App-CLI 是一款基于 Node.js 的命令行工具,用于部署和管理前端应用。 该工具提供了一些简单而强大的功能,如简化部署过程、自动化构建、打包代码等,方便开发者快速上线前端应用。

    4 年前
  • npm 包 peel-unused-css-in-miniprogram 使用教程

    前言 在前端开发过程中,我们通常会写大量的 CSS 样式代码。虽然是必须的工作,但在开发过程中会经常产生一些没用的 CSS 代码片段。这些无用的 CSS 代码不仅会影响页面加载速度,还可能导致一些潜在...

    4 年前
  • NPM包aws-s3-async使用教程

    前言 AWS S3是Amazon Web Services的对象存储服务,它能够在云端存储和检索任意量的数据,这样你就可以随时从任何地方访问你的数据。aws-s3-async被设计用来在Node.js...

    4 年前
  • npm 包 nn-cli 使用教程

    nn-cli 是一个针对机器学习开发的命令行工具,它可以帮助用户在命令行中快速进行模型训练以及测试。本文将详细介绍如何使用 npm 包 nn-cli,让用户能够快速上手。

    4 年前
  • npm 包 dumpinator 使用教程

    在前端开发中,我们经常需要调试和查看对象的结构和内容。而使用 dumpinator 这个 npm 包可以很方便地实现这个功能,并且无需手动逐个打印每个属性和方法。 在本文中,我们将学习如何使用 dum...

    4 年前
  • npm 包 gettencentaisign 使用教程

    简介 NPM (Node Package Manager,即 Node.js 包管理器) 是全球最大的开源软件库,其中有大量的前端类的库。gettencentaisign 就是其中之一,它是一个用于...

    4 年前
  • npm 包 project-js-footer 使用教程

    在前端开发中,项目的结构和代码的组织非常重要。为了方便代码的组织和管理,使用 npm 包可以提高我们的效率。本文将介绍一个非常实用的 npm 包:project-js-footer,该包用于为项目中的...

    4 年前
  • npm 包 sfra-module-loader 使用教程

    前言 sfra-module-loader 是一个开源的 npm 包,它可以帮助前端开发者更好地管理和组织模块,提高模块化开发的效率。它采用的是 CommonJS 规范,可以与 Node.js 或 B...

    4 年前
  • npm 包 bitb-pr 使用教程

    什么是 bitb-pr? bitb-pr 是一款 npm 包,用于在 GitLab 中进行 Pull Request 相关的操作。使用这个包,你可以轻松地获取、打开、关闭和合并 Pull Reques...

    4 年前
  • 使用 npm 包 egg-xprom 监控 Egg.js 应用程序

    引言 在开发和部署 Web 应用程序时,一个关键的方面是将应用程序监控起来,以便随时得知应用程序的运行状况和性能。为了实现这一目的,我们可以使用像 Prometheus 这样的工具来收集和存储监控指标...

    4 年前
  • npm 包 pomelo2-scheduler 使用教程

    前言 在现代 web 应用的开发中,Node.js 已经成为了一个无法替代的基础组件。作为一个框架和运行时环境,Node.js 提供了丰富的标准库和第三方包,使得开发者可以轻松实现各种功能。

    4 年前
  • npm 包 twxm 使用教程

    简介 twxm 是一个 npm 包,它提供了一些常见的前端工具函数,如格式化日期、数字格式化、浏览器判断等等。本文将详细讲解如何使用 twxm 包,包括安装、导入、函数使用和示例代码。

    4 年前
  • npm 包 vue-component-loading-screen 使用教程

    前端开发过程中,经常需要有 loading 动画来提高用户体验。而 vue-component-loading-screen 就是一个方便快捷的 npm 包,可以轻松地为 Vue 应用添加 loadi...

    4 年前
  • npm 包 centis 使用教程

    在前端开发中,我们会用到各种各样的工具和库,这些工具和库让我们的开发更加高效。npm 是一个包管理器,提供了大量的前端库和工具供我们使用。centis 就是其中一个 npm 包,它是一个用于处理时间和...

    4 年前
  • npm 包 @coturiv/angular-kits 使用教程

    1. 前言 在前端开发过程中,我们常常需要使用一些工具或库来提高开发效率和体验。而 npm,作为一个业界广泛使用的包管理器,为我们提供了许多优秀的前端库和工具。其中,@coturiv/angular-...

    4 年前
  • npm 包 json-editor-online 使用教程

    在前端开发中,我们常常需要编辑 JSON 数据。而使用 json-editor-online 这个 npm 包,可以方便地在网页上编辑和查看 JSON 数据。 在本教程中,我将教你如何使用 json-...

    4 年前
  • npm 包 mopass-common 使用教程

    介绍 npm 包 mopass-common 是一款专为前端开发者量身打造的代码库。它包含了社交登录、身份验证等常用功能的封装,旨在帮助前端开发者快速搭建项目,提高开发效率。

    4 年前
  • npm 包 github-release-rushjs-changelog1 使用教程

    前言 在前端开发过程中,经常需要将代码库发布到 Github 上,而在发布过程中,需要进行一系列的操作,如生成 changelog、打 tag、发布 Release 等。

    4 年前

相关推荐

    暂无文章