# sapit-ui 基座说明与业务使用文档 > 适用工程:sapit-ui-framework(基座/源码)、sapit-ui-plus(发布产物)、sapit-base-template(业务示例) > > 本文档也是基座内置文档页 `/docs`「说明文档」页签的数据源;同一页面的「内置组件」「工具配置」两个页签分别是组件库与配置速查。 --- ## 目录 - [一、总览](#docs-一总览) - [二、基座提供的内容](#docs-二基座提供的内容) - [三、构建与配置](#docs-三构建与配置) - [四、业务项目接入](#docs-四业务项目接入) - [五、注意事项](#docs-五注意事项) --- ## 一、总览 ### 1.1 五者关系 | 工程 | 角色 | 说明 | | --------------------- | ----------------------------------------------- | ----------------------------------------------------------------- | | `sapit-ui-framework` | 基座(源码) | 内置组件与常用依赖的库工程,Vite lib 模式打包 | | `sapit-ui-plus` | 发布产物 | 基座 `dist` 推送后的 git 仓库(`lib/`、`docs/`、`vite-plugins/`) | | `sapit-base-template` | 业务使用者 | 以 `sapit-ui-plus` git 依赖为底层,编写业务页面/配置 | ```text sapit-ui-framework --(npm run build)--> dist/lib --(git push)--> sapit-ui-plus(git) --> sapit-base-template ``` ### 1.2 依赖包结构 业务装的 `sapit-ui-plus` 只有运行时需要的内容(不是基座源码工程): ```text node_modules/sapit-ui-plus/ ├─ lib/ # 编译产物:js / css / 图片,业务 import 的就是它 ├─ docs/ # 本文档,由内置 /docs 页渲染 ├─ vite-plugins/ # 业务 vite.config.js 里按需引入的插件(如 sso-plugin) ├─ static/ # 静态资源(登录页图片等) └─ package.json ``` 业务只需要引三处:入口 `sapit-ui-plus`、样式 `sapit-ui-plus/lib/css/style.css`、按需的 `vite-plugins/*`。 --- ## 二、基座提供的内容 ### 2.1 全局组件 组件全部由基座**全局注册**,业务页面直接写标签即可,不需要 `import`、也不需要局部注册(如 ``、``、``)。 | 分类 | 组件 | | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 布局类 | `SSkeletonLayout`(骨架布局:标题 + 按钮组 + 内容区)、`SListLayout`、`SListCardLayout`(卡片列表)、`SListTableTreeLayout`、`SSuperListLayout`(高级列表:列设置 + 高级筛选)、`SFormLayout`、`SPanelLayout`、`SCollapses`/`SCollapsesItem`、`SDrawer` | | 弹层类 | `SModal`、`SModalTemplate`、`ModalHeader`、`SIconModal`、`SImportModal`(批量导入) | | 表单/筛选 | `SForm`、`SFormItem`(多列 + `full` 独占整行)、`SExtendFieldsForm`/`SExtendFieldsFormItem`(动态扩展字段)、`SFilterWrap`、`SFilterItem`(`full` 独占整行)、`SFilterToolbar`(查询区外壳:主区 + 更多筛选折叠 + 条件重置)、`STableToolbar`(表格区外壳:表体高度自动贴合内容区,与 `SFilterToolbar` 成对使用)、`SFilterTableToolbar`(查询区 + 表格区组合件)、`SCascader`、`STree`、`STreeSelect`、`SDataRangeTreeSelect`(数据权限范围树)、`SUserSelect`、`SUserSelectButton`、`SChooseUser`(带数据权限选人弹窗)、`SBelowChoosePosition`(选岗位弹窗)、`SOfficeSelect`、`SIconSelect`(图标下拉,可搜索/多选)、`SIconSelectPopover`(图标网格面板)、`SIconModal`(图标浏览弹窗) | | 上传类 | `SFileUpload`、`SDraggerUpload`、`SCopperUpload`、`CropperModal` | | 展示/其它 | `STab`/`STabItem`(标签栏,超出宽度自动出左右箭头)、`SEditor`、`SEmpty`、`SIcon`、`SSvg`、`SAnchor`、`SColorPicker`、`SToggleLanguage`、`SettingFilter`、`SettingColumns`、`SSideMenu`/`STopMenu` | > **每个组件的 props / 事件 / 方法 / 插槽、可运行预览与示例代码,统一看 `/docs` 页的「内置组件」页签**(「工具配置」页签列出 web-config 全部配置项与 `$utils` 全部方法)。 > > 几条使用口径: > > - 组件注册名是 **PascalCase**(`SForm` / `STable`),模板里写 `` 或 `` 都能解析,保持一致即可。 > - `@ant-design/icons-vue` 图标已全部全局注册,并把图标集合挂在 `$icons`。 > - 基座内部有几个不对外使用的辅助组件(如 `ModalHeader`、`CropperModal`、`SettingColumns` / `SettingFilter`),业务不要直接引用。 ### 2.2 全局属性 / 方法 `$registerGlobalConfig` 执行后可用(`this.$xxx` / 模板 `$xxx` / `window.$xxx`): | 名称 | 说明 | | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$registerGlobalConfig(config, pages)` | 初始化入口(见 4.2) | | `$utils` | 工具类集合:`$utils.env` / `$utils.ls` / `$utils.http` 及通用方法 | | `env` | 合并后的环境配置(= `$utils.env`) | | `$i18n` / `$l(name)` | 国际化(见 2.7)。挂在 `globalProperties` 上:**模板里直接用** `$l('xx')`;`