世界を変えるためのデザインシステムです
Getting started
Install
TBD
Usage
スタイルを適用するため node_modules/vibes/vibes.css を読み込んでください。
from Sass:
@import 'node_modules/vibes/vibes_2021';
from JavaScript with CSS Modules:
import '@freee_jp/vibes/css';
スタイルを読み込んだら、vibes の React Component を次のように使うだけです。
import * as React from 'react';
import { Breadcrumbs } from '@freee_jp/vibes';
import { CompanyLogoT } from 'somewhere';
export default function App() {
return (
<div className="app">
<CompanyLogoT size="fit-width" fill="default"/>
<Breadcrumbs
links={[
{ title: '取引', url: '/hub_pages/deals' },
{ title: '自動で経理', url: '/wallet_txns/stream' },
]}
/>
</div>
);
}
Contribution
こちらのガイドラインを参照してください。
关于 @freee_jp/vibes 的常见问题
@freee_jp/vibes 是什么?
世界を変えるためのデザインシステムです
如何安装 @freee_jp/vibes?
在项目目录运行 npm install @freee_jp/vibes,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^16.8.x || ^17 || ^18)、react-dom(^16.8.x || ^17 || ^18)、lottie-web(^5.5.7)、react-modal(^3.7.1)、styled-components(^5)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
@freee_jp/vibes 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@freee_jp/vibes 支持 ESM 还是 CommonJS?
同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。
@freee_jp/vibes 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >= 14。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@freee_jp/vibes 可以商用吗?
@freee_jp/vibes 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。
@freee_jp/vibes 的下载量有多少?
根据 npm 官方下载统计,@freee_jp/vibes 在 2026/10/16 – 2026/11/14 这 30 天内被下载 2,517 次,日均约 84 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@freee_jp/vibes 还在维护吗?
最新版本 100.1.0 发布于 2024/01/18(2 年前);至今共发布 2 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/12/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。