@dxos/ui-types 0.0.0

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# @dxos/ui-types
+
+Types for DXOS UI and its themes.
+
+## Installation
+
+```bash
+pnpm i @dxos/ui-types
+```
+
+## Documentation
+
+- [📖 Developer Guide](https://docs.dxos.org/guide/react/aurora/)
+
+## DXOS Resources
+
+- [Website](https://dxos.org)
+- [Developer Documentation](https://docs.dxos.org)
+- Talk to us on [Discord](https://dxos.org/discord)
+
+## Contributions
+
+Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
+
+License: [MIT](./LICENSE) Copyright 2022 © DXOS

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@dxos/ui-types",
+  "version": "0.0.0",
+  "description": "Types for DXOS UI and theme.",
+  "homepage": "https://dxos.org",
+  "bugs": "https://github.com/dxos/dxos/issues",
+  "license": "MIT",
+  "author": "DXOS.org",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/types/src/index.d.ts",
+      "browser": "./dist/lib/browser/index.mjs",
+      "node": "./dist/lib/node-esm/index.mjs"
+    }
+  },
+  "types": "dist/types/src/index.d.ts",
+  "typesVersions": {
+    "*": {}
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "i18next": "^21.10.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/anchor.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export const DX_ANCHOR_ACTIVATE = 'dx-anchor-activate';
+
+/**
+ * Global event to trigger a popover.
+ */
+export class DxAnchorActivate extends Event {
+  public readonly refId: string;
+  public readonly label: string;
+  public readonly trigger: HTMLElement;
+  constructor(props: { refId: string; label: string; trigger: HTMLElement }) {
+    super(DX_ANCHOR_ACTIVATE);
+    this.refId = props.refId;
+    this.label = props.label;
+    this.trigger = props.trigger;
+  }
+}

package/src/density.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export type Density = 'coarse' | 'fine';

package/src/elevation.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+export type Elevation = 'base' | 'positioned' | 'toast' | 'dialog';
+export type SurfaceLevel = 'base' | 'menu' | 'tooltip';

package/src/index.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+export * from './anchor';
+export * from './menu';
+export * from './translations';
+
+export type * from './density';
+export type * from './elevation';
+export type * from './message';
+export type * from './palette';
+export type * from './size';
+export type * from './theme';

package/src/menu.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type ClassNameValue } from './theme';
+import { type Label } from './translations';
+
+export type MenuActionProperties = {
+  label: Label;
+  icon?: string;
+  value?: string;
+  disabled?: boolean;
+  hidden?: boolean;
+  iconOnly?: boolean;
+  testId?: string;
+  variant?: 'action' | 'toggle';
+  checked?: boolean;
+  classNames?: ClassNameValue;
+};
+
+export type MenuItemGroupProperties = {
+  label: Label;
+  icon?: string;
+  iconOnly?: boolean;
+};

package/src/message.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+export type MessageValence = 'success' | 'info' | 'warning' | 'error' | 'neutral';

package/src/palette.ts

@@ -0,0 +1,27 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export type ChromaticPalette =
+  | 'red'
+  | 'orange'
+  | 'amber'
+  | 'yellow'
+  | 'lime'
+  | 'green'
+  | 'emerald'
+  | 'teal'
+  | 'cyan'
+  | 'sky'
+  | 'blue'
+  | 'indigo'
+  | 'violet'
+  | 'purple'
+  | 'fuchsia'
+  | 'pink'
+  | 'rose';
+
+export type PrimaryPalette = 'primary';
+export type NeutralPalette = 'neutral';
+
+export type Palette = ChromaticPalette | PrimaryPalette | NeutralPalette;

package/src/size.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+export type Size =
+  | 0
+  | 'px'
+  | 0.5
+  | 1
+  | 1.5
+  | 2
+  | 2.5
+  | 3
+  | 3.5
+  | 4
+  | 5
+  | 6
+  | 7
+  | 8
+  | 9
+  | 10
+  | 11
+  | 12
+  | 14
+  | 16
+  | 20
+  | 24
+  | 28
+  | 32
+  | 36
+  | 40
+  | 44
+  | 48
+  | 52
+  | 56
+  | 60
+  | 64
+  | 72
+  | 80
+  | 96;

package/src/theme.ts

@@ -0,0 +1,26 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export type ClassNameValue = ClassNameArray | string | null | undefined | 0 | false;
+export type ClassNameArray = ClassNameValue[];
+
+export type ComponentFunction<P extends Record<string, any>> = (styleProps: P, ...etc: ClassNameArray) => string;
+export type ComponentFragment<P extends Record<string, any>> = (styleProps: P) => ClassNameValue[];
+
+export type Theme<P extends Record<string, any>> = { [key: string]: Theme<P> | ComponentFunction<P> };
+export type ThemeMode = 'dark' | 'light';
+export type ThemeFunction<P extends Record<string, any>> = (
+  path: string,
+  defaultClassName: string,
+  styleProps?: P,
+  ...etc: ClassNameArray
+) => string;
+
+export type ThemedClassName<P = {}> = Omit<P, 'className'> & { classNames?: ClassNameValue };
+
+/**
+ * For components that are children of Radix-style asChild primitives.
+ * className={mx('', className, classNames)}
+ */
+export type SlottableClassName<P = {}> = P & { className?: string; classNames?: ClassNameValue };

package/src/translations.ts

@@ -0,0 +1,20 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { type TFunction } from 'i18next';
+
+// TODO(thure): `Parameters<TFunction>` causes typechecking issues because `TFunction` has so many signatures.
+export type Label = string | [string, { ns: string; count?: number; defaultValue?: string }];
+
+export const isLabel = (o: any): o is Label =>
+  typeof o === 'string' ||
+  (Array.isArray(o) &&
+    o.length === 2 &&
+    typeof o[0] === 'string' &&
+    !!o[1] &&
+    typeof o[1] === 'object' &&
+    'ns' in o[1] &&
+    typeof o[1].ns === 'string');
+
+export const toLocalizedString = (label: Label, t: TFunction) => (Array.isArray(label) ? t(...label) : label);