@fusebase/fusebase-dashboards (英语)
FuseBase数据库用于React的UI:数据库列表和表格屏幕. 它运行在FuseBase仪表板API上,通过主机提供的传输.
安装
npm install @fusebase/fusebase-dashboards
端点 : react 财务报告和审定财务报表 react-dom 18岁或以后。 软件包不需要 Next.js.
@tanstack/react-query 5是一个依赖。 如果你的应用程序有一个 QueryClientProvider 在屏幕上方,软件包使用该客户端。 如果您的应用程序有不同的 5.x 版本, npm 将安装第二个副本, 然后软件包自行制作 QueryClient。要共享一个客户端,请使用与软件包相同的5.x版本.
长文本单元格渲染下标记 @fusebase/markdown-viewer,仅在表格有长文本时才加载。 查看器有可选的动态导入( :katex, (中文(简体) ), mermaid, (中文(简体) ), dompurify, (中文(简体) ), highlight.js/lib/common) (中文(简体) ). 您的捆绑者必须解决它们: 安装它们, 或将其化名到空模块( webpack: resolve.alias: { katex: false, ... }) (中文(简体) ). 没有它们,数学,图表和代码显示为纯文本.
打开长文本单元格 @milkdown/crepe (v2单元格的编辑器)在编辑上,也作为一个懒散块. 克里普进口 dompurify,所以不要用别名 dompurify 到空模块。 数学在编辑器里停了 所以 katex 别名是安全的.
支助科
导入两个文件一次 :
import "@fusebase/fusebase-dashboards/tokens.css";
import "@fusebase/fusebase-dashboards/styles.css";
tokens.css 有默认 --db-* 变量。 文本使用主机页面的字体( Q)--db-font-body 实值 inherit) (中文(简体) ). styles.css 以这些变量为组件样式。 所有软件包 UI 都在 a .db-root 元素,这样一个主机就可以以规则更改主题 .db-root。 。 。 . :root .db-root 胜过 tokens.css 在任何导入顺序中:
:root .db-root {
--db-page: #101010;
--db-text: #f2f2f2;
}
表格网格在自己的框中滚动,最多 70vh 高,有粘相头;只使行靠近卷轴位置. 要改变高度,请添加如下规则: .db-root .db-grid { max-height: 60vh; }。 。 。 .
使用量
import {
createDashboardsClient,
DashboardsProvider,
DatabasesScreen,
TableScreen,
} from "@fusebase/fusebase-dashboards";
const client = createDashboardsClient({
// The dashboard API origin with `/api/v1`, or a backend that forwards there.
baseUrl: "/api/dashboards",
// The host adds credentials or auth headers. The package never calls the global fetch.
fetch: (input, init) => fetch(input, { ...init, credentials: "include" }),
});
export function Databases({ orgId }: { orgId: string }) {
return (
<DashboardsProvider client={client}>
<DatabasesScreen
orgId={orgId}
navigate={(href) => history.pushState(null, "", href)}
/>
</DashboardsProvider>
);
}
baseUrl 在浏览器中只能是相对的。 在节点中,给出绝对的URL.
东道方合同
DashboardsProvider 道具 :
| Prop | 说明 |
|---|---|
client | 从 createDashboardsClient({ baseUrl, fetch })。 。 。 . |
dictionary | 替换英文默认值的文本(defaultDictionary) (中文(简体) ). |
pageSize | 每页行. 如果不设定,则使用用户所保存的值. |
loadAssignees | () => Promise<AssigneeOption[]>: 受让人单元格可以持有的用户({ id, name, email?, client? }) (中文(简体) ). 没有它,受让人单元格只能读取. |
uploadFiles | (files: File[], context: FileCellContext) => Promise<DashboardFile[]>: 上传文件和返回 { name, url, ... } 每一个。 没有它,文件单元格就没有上传控制(移除仍然有效). |
filesBaseUrl | 相对文件的基础 url (v2仓库) /uuid/name);工作室通行证 /box/file绝对值 url 以原样使用. |
屏幕道具 :
| Prop | 说明 |
|---|---|
orgId | 组织编号. |
databaseId | TableScreen 只有这个. |
tableId | TableScreen,可选。 没有它,屏幕就会进入第一桌. |
viewId | TableScreen,可选。 没有它,屏幕会进入默认视图. |
linkComponent | 可选的 您的路由器链接, 与 href 财务报告和审定财务报表 children 道具来. 没有它,包裹就 <a> 呼唤 navigate。 。 。 . |
navigate | (href, { replace }) => void。 。 。 . replace: true 用于重定向。 保持此函数的稳定(例如:, useCallback) (中文(简体) ). |
肝脏有形状 /:orgId/databases/:databaseId/tables/:tableId/views/:viewId (单位:千美元)databasesHref, (中文(简体) ), databaseHref, (中文(简体) ), tableHref) (中文(简体) ). 如果您的应用程序有基础路径, 请添加到 linkComponent 财务报告和审定财务报表 navigate。 。 。 .
错误: 每一次失败的 API 呼叫都是 a DashboardsError 与 status 财务报告和审定财务报表 message。 。 。 .
软件包保留每页行数 localStorage 下级 fusebase.dashboards.pageSize。 。 。 .
嵌入条目
import {
createDashboardsClient,
DashboardsProvider,
} from "@fusebase/fusebase-dashboards/embed";
@fusebase/fusebase-dashboards/embed 用于只显示嵌入式表格的页面。 它不装入数据库列表 。 两个条目都共享一个块,所以一个条目的提供者与另一个条目的屏幕工作.
许可证
见 LICENSE。 。 。 .