安装
使用 npm :
$ npm install @axos-web-dev/shared-components
导入组件 在节点.js中:
// Import Components
import {
AlertBanner,
CallToActionBar,
DownloadTile,
ImageBillboard,
SecondaryFooter,
} from "@axos-web-dev/shared-components";
// Import Types/Interfaces
import { AlertBannerInterface } from "@axos-web-dev/shared-components/dist/AlertBanner/AlertBanner.interface";
在 cs 文件内 :
/*** Import styles ***/
@import "@axos-web-dev/shared-components/dist/assets/AlertBanner/AlertBanner.css";
共享组件
这个项目是利用 React + TypeScript + Vite + Storybook + Vanilla-extract 用于构建内部使用的自定义组件.
如何添加新组件
添加新组件时使用 src/lib 文件夹,并为组件创建文件夹。 在此之后,您应该注册导出 src/lib/main.ts 文档.
您还需要为新组件创建 storie 。 转到 src/stories 并创建新文件或文件夹.
git clone [email protected]:v3/bofaz/Axos%20Marketing%20Cloud/Shared%20Components shared-components
cd shared-components
npm install
# for using storybook
npm run storybook
# for build
npm run build
# for testing in other projects
npm run build
npm link
为了出版,我们需要 涂抹我们使用的版本 语义版本
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes
MINOR version when you add functionality in a backward compatible manner
PATCH version when you make backward compatible bug fixes
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
我们可以使用以下命令更新版本:
# bumps the patch number like 0.0.0 -> 0.0.1
npm version patch
# bumps the patch number like 0.0.0 -> 0.1.0
npm version minor
# bumps the patch number like 0.0.0 -> 1.0.0
npm version major
如何发布 npm 的新库版本
如前所述,第一次更新版本
npm version [...]
然后,您需要登录 npm 来完成此写:
npm login --scope=@my-org
最后您要发布新版本 :
npm publish