Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix API docs #2910

Merged
merged 3 commits into from
Feb 4, 2025
Merged

Fix API docs #2910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0bf7aa
Fix API docs
texodus Feb 2, 2025
d9932be
Document custom themes, remove default label visibility
texodus Feb 2, 2025
415285a
Fix TypeScript plugin exports
texodus Feb 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/md/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
- [Hosting a `WebSocketServer` in Node.js](./how_to/javascript/nodejs_server.md)
- [`perspective-viewer` Custom Element library](./how_to/javascript/viewer.md)
- [Theming](./how_to/javascript/theming.md)
- [Custom Themes](./how_to/javascript/custom_themes.md)
- [Loading data from a `Table`](./how_to/javascript/loading_data.md)
- [Loading data from a virtual `Table`](./how_to/javascript/loading_virtual_data.md)
- [Saving and restoring UI state](./how_to/javascript/save_restore.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/md/how_to/javascript/custom_themes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Custom themes

The best way to write a new theme is to
[fork and modify an existing theme](https://github.com/finos/perspective/tree/master/rust/perspective-viewer/src/themes),
which are _just_ collections of regular CSS variables (no preprocessor is
required, though Perspective's own themes use one). `<perspective-viewer>` is
not "themed" by default and will lack icons and label text in addition to colors
and fonts, so starting from an empty theme forces you to define _every_
theme-able variable to get a functional UI.

### Icons and Translation

UI icons are defined by CSS variables provided by
[`@finos/perspective-viewer/dist/css/icons.css`](https://github.com/finos/perspective/blob/master/rust/perspective-viewer/src/themes/icons.less).
These variables must be defined for the UI icons to work - there are no default
icons without a theme.

UI text is also defined in CSS variables provided by
[`@finos/perspective-viewer/dist/css/intl.css`](https://github.com/finos/perspective/blob/master/rust/perspective-viewer/src/themes/intl.less),
and has identical import requirements. Some _example definitions_
(automatically-translated sans-editing) can be found
[`@finos/perspective-viewer/dist/css/intl/` folder](https://github.com/finos/perspective/tree/master/rust/perspective-viewer/src/themes/intl).

Importing the pre-built `themes.css` stylesheet as well as a custom theme will
define Icons and Translation globally as a side-effect. You can still customize
icons in this mode with rules (of the appropriate specificity), _but_ if you do
not still remember to define these variables yourself, your theme will not work
without the base `themes.css` pacage available.
22 changes: 12 additions & 10 deletions examples/blocks/src/editable/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@
<html>
<head>
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,minimum-scale=1,user-scalable=no" />
<link rel="preload" href="/node_modules/@finos/perspective/dist/wasm/perspective-server.wasm" as="fetch" type="application/wasm" crossorigin="anonymous" />
<link rel="preload" href="/node_modules/@finos/perspective-viewer/dist/wasm/perspective-viewer.wasm" as="fetch" type="application/wasm" crossorigin="anonymous" />
<link rel="preload" href="/node_modules/superstore-arrow/superstore.lz4.arrow" as="fetch" type="arraybuffer" crossorigin="anonymous" />
<link rel="stylesheet" crossorigin="anonymous" href="/node_modules/@finos/perspective-viewer/dist/css/themes.css" />
<link rel="preload" href="https://cdn.jsdelivr.net/npm/@finos/perspective/dist/cdn/perspective-server.wasm" as="fetch" type="application/wasm" crossorigin="anonymous" />
<link rel="preload" href="https://cdn.jsdelivr.net/npm/@finos/perspective-viewer/dist/cdn/perspective-viewer.wasm" as="fetch" type="application/wasm" crossorigin="anonymous" />
<link rel="preload" href="https://cdn.jsdelivr.net/npm/superstore-arrow/superstore.lz4.arrow" as="fetch" type="arraybuffer" crossorigin="anonymous" />
<!-- <link rel="stylesheet" crossorigin="anonymous" href="https://cdn.jsdelivr.net/npm/@finos/perspective-viewer/dist/css/themes.css" /> -->
<link rel="stylesheet" href="customStyle.css" />
<script type="module">
import "/node_modules/@finos/perspective-viewer/dist/cdn/perspective-viewer.js";
import "/node_modules/@finos/perspective-viewer-datagrid/dist/cdn/perspective-viewer-datagrid.js";
import "/node_modules/@finos/perspective-viewer-d3fc/dist/cdn/perspective-viewer-d3fc.js";
import "https://cdn.jsdelivr.net/npm/@finos/perspective-viewer@3.3.2/dist/cdn/perspective-viewer.js";
import "https://cdn.jsdelivr.net/npm/@finos/perspective-viewer-datagrid@3.3.2/dist/cdn/perspective-viewer-datagrid.js";
import "https://cdn.jsdelivr.net/npm/@finos/perspective-viewer-d3fc@3.3.2/dist/cdn/perspective-viewer-d3fc.js";

import perspective from "/node_modules/@finos/perspective/dist/cdn/perspective.js";
import perspective from "https://cdn.jsdelivr.net/npm/@finos/perspective@3.3.2/dist/cdn/perspective.js";

const worker = await perspective.worker();
const resp = await fetch("/node_modules/superstore-arrow/superstore.lz4.arrow");
const resp = await fetch("https://cdn.jsdelivr.net/npm/superstore-arrow/superstore.lz4.arrow");
const arrow = await resp.arrayBuffer();
const viewer = document.getElementsByTagName("perspective-viewer")[0];
const table = worker.table(arrow);
viewer.load(table);
viewer.restore({ settings: true, plugin_config: { edit_mode: "EDIT" } });
viewer.restore({ settings: true });
viewer.resetThemes(["Style1", "Pro Dark", "Pro Light"]);
</script>
<style>
perspective-viewer {
Expand Down
4 changes: 3 additions & 1 deletion examples/react-example/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
},
"devDependencies": {
"esbuild": "^0.14.54",
"http-server": "^14.1.1"
"http-server": "^14.1.1",
"@types/react": "^18",
"@types/react-dom": "^18"
}
}
11 changes: 8 additions & 3 deletions examples/react-example/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ import perspective from "@finos/perspective";
import perspective_viewer from "@finos/perspective-viewer";
import "@finos/perspective-viewer-datagrid";
import "@finos/perspective-viewer-d3fc";
import type { ViewerConfigUpdate } from "@finos/perspective-viewer";
import type {
HTMLPerspectiveViewerElement,
ViewerConfigUpdate,
} from "@finos/perspective-viewer";

import "@finos/perspective-viewer/dist/css/themes.css";
import "./index.css";
Expand Down Expand Up @@ -50,7 +53,7 @@ const config: ViewerConfigUpdate = {
};

const App = (): React.ReactElement => {
const viewer = React.useRef(null);
const viewer = React.useRef<HTMLPerspectiveViewerElement>(null);
React.useEffect(() => {
getTable().then((table) => {
if (viewer.current) {
Expand All @@ -63,4 +66,6 @@ const App = (): React.ReactElement => {
return <perspective-viewer ref={viewer}></perspective-viewer>;
};

ReactDOM.createRoot(document.getElementById("root")).render(<App />);
ReactDOM.createRoot(
document.getElementById("root") as ReactDOM.Container
).render(<App />);
2 changes: 1 addition & 1 deletion examples/react-example/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"noImplicitUseStrict": false,
"noUnusedLocals": true,
"strictNullChecks": true,
"skipLibCheck": true,
"skipLibCheck": false,
"removeComments": false,
"jsx": "react",
"allowSyntheticDefaultImports": true,
Expand Down
4 changes: 2 additions & 2 deletions packages/perspective-viewer-d3fc/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"type": "module",
"exports": {
".": {
"types": "./dist/esm/types/index.d.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/perspective-viewer-d3fc.js"
},
"./src/*": "./src/*",
Expand All @@ -31,7 +31,7 @@
"src/**/*",
"index.d.ts"
],
"types": "dist/esm/types/index.d.ts",
"types": "dist/esm/index.d.ts",
"scripts": {
"prebuild": "mkdirp dist/esm",
"build": "node ./build.js",
Expand Down
6 changes: 4 additions & 2 deletions packages/perspective-viewer-datagrid/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
"unpkg": "dist/cdn/perspective-viewer-datagrid.js",
"jsdelivr": "dist/cdn/perspective-viewer-datagrid.js",
"exports": {
".": "./dist/esm/perspective-viewer-datagrid.js",
".": {
"types": "./index.d.ts",
"default": "./dist/esm/perspective-viewer-datagrid.js"
},
"./dist/*": "./dist/*",
"./package.json": "./package.json"
},
Expand All @@ -14,7 +17,6 @@
"dist/**/*",
"index.d.ts"
],
"types": "index.d.ts",
"scripts": {
"build": "node build.js",
"clean": "rimraf dist",
Expand Down
23 changes: 19 additions & 4 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions rust/perspective-js/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ keywords = ["experimental"]
include = ["src/**/*", "Cargo.toml", "./package.json", "docs/**/*", "build.rs"]

[package.metadata.docs.rs]
features = ["external-docs"]
rustc-args = ["--cfg", "web_sys_unstable_apis"]
rustdoc-args = ["--html-in-header", "docs/index.html"]

Expand Down
1 change: 1 addition & 0 deletions rust/perspective-python/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ include = [
]

[package.metadata.docs.rs]
features = ["external-docs"]
rustdoc-args = ["--html-in-header", "docs/index.html"]

[features]
Expand Down
2 changes: 1 addition & 1 deletion rust/perspective-viewer/src/less/config-selector.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@
top: 0px;
margin: var(--column-drop-label--margin, -16px 0px 0px 0px);
font-size: var(--label--font-size, 0.75em);
display: var(--column-drop-label--display, none);
display: inline-block;
}

#transpose_button {
Expand Down
1 change: 0 additions & 1 deletion rust/perspective-viewer/src/themes/pro.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ perspective-string-column-style[theme="Pro Light"] {
--config-button--padding: 15px 8px 6px 8px;
--column-drop-label--font-size: 8px;
--column-drop-container--padding: 0px;
--column-drop-label--display: inline-block;
--column-selector--width: 20px;
--column-selector--font-size: 16px;

Expand Down
Loading