npm 包 @primer/octicons-v2 使用教程

前言

在前端开发中，我们经常需要使用一些图标来丰富页面内容。GitHub 的无数图标设计得非常优秀，对于前端开发来说也是个很好的资源。但是，如果手动去下载、引入这些图标，随着图标数量的增多，维护成本将逐渐变高。因此，GitHub 推出了 @primer/octicons-v2，也就是本篇文章要介绍的内容。

什么是 @primer/octicons-v2？

@primer/octicons-v2 是 GitHub 官方的一个图标库，它是一组矢量图标，图标数量很多，包括各种常用场景和动态的图标，如常见的文件类型图标、Badge、各种状态和带有文字的图标等。且这些图标全部以 SVG 格式存储，使得它们可以保持高清晰度并且缩放不失真。

如何使用 @primer/octicons-v2？

@primer/octicons-v2 包含两个部分：Octicons（图标库本身）和 Octicons React（React 框架下的图标库）。在本篇文章中，我们侧重于介绍 Octicons。

首先，你需要在项目目录下使用 npm 安装 @primer/octicons-v2：

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

然后，你可以使用如下的语句引入 @primer/octicons-v2，在本篇文章中，我们将引入所有的图标：

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

之后，你就可以在项目代码中直接使用图标了。例如，我们可以使用如下语句在页面上显示一个 issue 的默认图标：

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

除此之外，@primer/octicons-v2 还支持 SVG 属性的传递，例如通过 style 改变颜色：

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

可用的图标

@primer/octicons-v2 的图标数量非常多，全部都可以在官网上查看。其中最为常用的图标可能就是如下这些：

  • Alert
  • Archive
  • ArrowDown
  • ArrowLeft
  • ArrowRight
  • ArrowUp
  • Book
  • Bookmark
  • Briefcase
  • Broadcast
  • Browser
  • Bug
  • Calendar
  • Check
  • Checklist
  • ChevronDown
  • ChevronLeft
  • ChevronRight
  • ChevronUp
  • Circle
  • Code
  • Comment
  • CommentDiscussion
  • CreditCard
  • Dash
  • Dashboard
  • Database
  • Dependabot
  • DesktopDownload
  • DeviceCamera
  • DeviceDesktop
  • DeviceMobile
  • Diff
  • DiffAdded
  • DiffIgnored
  • DiffModified
  • DiffRemoved
  • DiffRenamed
  • Ellipsis
  • Eye
  • File
  • FileBinary
  • FileCode
  • FileDiff
  • FileDirectory
  • FileMedia
  • FilePdf
  • FileSubmodule
  • FileSymlinkFile
  • FileSymlinkSubmodule
  • FileZip
  • Filter
  • Fold
  • Gear
  • Gift
  • GitBranch
  • GitCommit
  • GitCompare
  • GitForkPrivate
  • GitMerge
  • GitPullRequest
  • Globe
  • Graph
  • Heart
  • History
  • Home
  • HorizontalRule
  • Hourglass
  • Hubot
  • Inbox
  • Infinity
  • Info
  • IssueClosed
  • IssueOpened
  • IssueReopened
  • Italic
  • JumpDown
  • JumpLeft
  • JumpRight
  • JumpUp
  • Key
  • Law
  • LightBulb
  • Link
  • LinkExternal
  • ListOrdered
  • ListUnordered
  • Location
  • Lock
  • LogoGist
  • LogoGithub
  • Mail
  • MarkGithub
  • Markdown
  • Megaphone
  • Mention
  • Milestone
  • Mirror
  • Moon
  • MortarBoard
  • Mute
  • NoEntry
  • NorthStar
  • Note
  • Octoface
  • Organization
  • Package
  • PackageDependencies
  • PackageDependents
  • Paintcan
  • Pencil
  • Person
  • Pin
  • Play
  • Plug
  • Plus
  • PlusCircle
  • Project
  • Pulse
  • Question
  • Quote
  • RadioTower
  • Reply
  • Repo
  • RepoClone
  • RepoForcePush
  • RepoForked
  • RepoPull
  • RepoPush
  • RepoTemplate
  • Report
  • Rocket
  • Rss
  • Ruby
  • ScreenFull
  • ScreenNormal
  • Search
  • Server
  • Settings
  • Shield
  • SignIn
  • SignOut
  • Skip
  • Smiley
  • Square
  • SquareFill
  • Star
  • Stop
  • Stopwatch
  • Sun
  • Support
  • Sync
  • Tab
  • Tag
  • Tasklist
  • Telescope
  • Terminal
  • TextSize
  • ThreeBars
  • Thumbsdown
  • Thumbsup
  • Tools
  • Trashcan
  • TriangleDown
  • TriangleLeft
  • TriangleRight
  • TriangleUp
  • Typing
  • Unfold
  • Unlock
  • Unmute
  • Unverified
  • Upload
  • Verified
  • Versions
  • Workflow
  • X
  • XCircle
  • Zap

结语

@primer/octicons-v2 是一个非常优秀的图标库，它包含了各种常用的图标，使用方便，非常适合在前端开发中使用。同时，@primer/octicons-v2 的安装、引入和使用也非常简单，难度不大。如果你需要在项目中使用图标，强烈推荐使用 @primer/octicons-v2！

示例代码：

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

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

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

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5ef187a48c4ce90ee4ca3b06

阅读全文

猜你喜欢

  • HTML的标签

    HTML标签详解 HTML（Hypertext Markup Language）是一种用于创建网页的标记语言。在HTML中，有许多不同类型的标签可以用来定义网页的结构和内容。

    4 年前
  • npm包 exif-parser 使用教程

    简介 在前端开发中，我们经常遇到需要读取照片中的一些信息，比如拍照时间、曝光时间、ISO等等。而这些信息通常都被嵌入在照片中的 exif 数据中。exif-parser 就是一个可以帮助我们解析 ex...

    4 年前
  • npm 包 @types/terser 使用教程

    前言 前端开发中，我们经常需要压缩 JavaScript 代码以提高页面的加载速度，而 Terser 是一个高效的 JavaScript 压缩工具，可以帮助我们完成这个任务。

    4 年前
  • npm 包 @percy/agent 使用教程

    简介 @percy/agent 是一个用于测试和集成的 JavaScript 应用程序的开源软件包，可轻松捕获页面渲染，并在屏幕截图中进行比较。@percy/agent 依靠 Percy 服务，为用户...

    4 年前
  • npm 包 freelist 使用教程

    介绍 npm 包 freelist 是一个用于高性能内存管理的开源库，它可以优化内存的使用，从而提高应用的性能。使用 freelist 可以有效地减少应用的内存峰值和内存碎片。

    4 年前
  • npm 包 eslint-config-kswedberg 使用教程

    在前端开发中，我们经常需要使用静态代码检查工具来规范我们的代码，并保证代码的质量和一致性。而其中较为流行的一种工具就是 eslint，它可以在编辑器中实时检查代码，并给出相应的错误和警告信息。

    4 年前
  • npm 包 abstract-chunk-store 使用教程

    在前端开发中，处理大量数据是一件很常见的事情。abstract-chunk-store 是一个 npm 包，它允许我们将大数据切片，并以一种统一的方式进行存储和处理。

    4 年前
  • npm 包 cln 使用教程

    什么是 cln？ cln 是一个使用 JavaScript 编写的高精度计算库，可以进行任意精度的整数和有理数计算。它是一个 npm 包，可以被前端和后端项目使用。

    4 年前
  • npm 包 escaper 使用教程

    介绍 escaper 是一款用于处理 HTML、CSS 和 JavaScript 转义的 npm 包。在前端开发中，经常需要将一些特殊字符进行转义，防止出现安全问题或者显示错乱等情况。

    4 年前
  • npm 包 piece-length 使用教程

    在前端开发中，我们经常需要进行数据分片处理。npm 包 piece-length 就是一个很好的选择。它可以用来将一个大数据分成指定大小的小数据块，并且可以对每个块进行加密、签名等处理。

    4 年前
  • npm包filestream使用教程

    在前端开发中，处理文件是很常见的任务。filestream是一个npm包，可以帮助我们简洁、高效地处理文件。本文将详细介绍如何使用filestream这个npm包，希望可以为前端工程师提供帮助。

    4 年前
  • npm 包 tiny-json-http 使用教程

    在前端开发中，经常会需要向后端请求数据接口，而此时使用的工具就是 http 请求。但是，由于 http 请求的使用较为繁琐，因此出现了许多 http 请求的封装库，其中，tiny-json-http ...

    4 年前
  • npm 包 cache-chunk-store 使用教程

    概述 在前端项目开发过程中，经常需要从服务器上获取分块数据。这些数据可能非常大，因此传输和存储的效率对应用性能非常关键。cache-chunk-store 是一个 npm 包，它通过使用一个类似缓存的...

    4 年前
  • npm 包 @esfx/disposable 使用教程

    随着前端开发的发展，我们越来越需要使用像 node.js 这样的工具来处理我们的项目。Node.js 包管理器（npm）是一个伟大的工具，它提供了一个庞大的生态系统，让我们能够使用各种模块来实现我们的...

    4 年前
  • 使用 @esfx/cancelable 包

    @esfx/cancelable 是一个被广泛使用的npm包，用于在JavaScript中实现cancellation 和 abortability 的功能。它可用于取消promise, setTim...

    4 年前
  • npm 包 grunt-gulp 使用教程

    什么是 grunt 和 gulp？ 在介绍如何使用 npm 包 grunt-gulp 前，让我们先了解一下 grunt 和 gulp。 grunt 和 gulp 都是前端自动化构建工具，它们可以帮助我...

    4 年前
  • npm 包 @types/tinycolor2 使用教程

    今天我们将会学习如何使用 npm 包 @types/tinycolor2 来管理我们前端项目中的颜色值。这个 npm 包提供了一个强大的颜色处理类，可以用于处理混合色、颜色值计算、格式化等等操作。

    4 年前
  • 前端开发指南：npm 包 @pixi/canvas-renderer 使用教程

    介绍 在前端开发过程中，我们会经常使用到各种第三方库或者 npm 包来提高自己的开发效率。其中一个非常实用的 npm 包就是 @pixi/canvas-renderer。

    4 年前
  • npm 包 jqlite 使用教程

    jqlite 是一个精简版的 jQuery，它实现了 jQuery 的一部分功能，代码量更为精简，适用于在项目中，只需要使用 jQuery 的部分功能的情况。本文将介绍 jqlite 的使用方法，希望...

    4 年前
  • npm 包 rc-field-form 使用教程

    引言 在前端开发中，我们经常需要处理表单的输入输出，表单的校验以及表单数据的提交等一系列操作。而在 React 中，我们可以通过使用 npm 包 rc-field-form 来方便地进行表单处理。

    4 年前

相关推荐

    暂无文章