YxLive 组件库 README

YxLive

银象直播 HTML 原生组件库
基于 Web Components，零框架依赖

🌟 简介

YxLive 是银象直播官方推出的原生 Web Components 组件库 （此处添加2个空格） 不依赖任何前端框架，开箱即用，轻量高效，适用于所有 Web 项目。

📦 安装方式

1. CDN 引入（推荐）

<!-- 必需依赖 -->
<script src="https://unpkg.com/@yxlib/core/dist/@yxlib/core.js"></script>
<!-- yx-live -->
<script src="https://unpkg.com/yx-live/dist/yx-live.js"></script>

2. NPM 安装

npm install yx-live @yxlib/core

@yxlib/core 为必需的对等依赖（peer dependency），需一并安装。

🚀 快速上手

CDN 直接使用

<color-name
  nickname="月影惊鸿"
  skin="/assets/default.zip"
  size="20px"
></color-name>

<script>
  YxCore.InitRegion();
</script>

NPM + 模块化使用

import { InitRegion } from "@yxlib/core";
import "yx-live";

InitRegion();

🧩 组件文档

彩色昵称组件

| 属性 | 说明 | 示例值 | | :--- | :--- | :--- | | nickname | 展示昵称 | 月影惊鸿 | | skin | 皮肤资源路径 | /assets/default.zip | | size | 字体大小 | 20px |

🛠️ 本地开发

# 安装项目依赖
npm install

# 启动开发服务
npm run dev

# 生产环境构建
npm run build

⚠️ 版权声明

协议类型：Commercial / Proprietary（商业私有） 未经官方授权，禁止任何形式的复制、分发、修改或二次发布本组件库。

👤 作者

斩神

© 2026 银象直播. All Rights Reserved.