@flux-ui/types 3.0.0-next.3 → 3.0.0-next.30

package/README.md

@@ -1,45 +1,3 @@
-# Flux
+# `@flux-ui/types`
 
-This repository contains the source code for the basic components that are used throughout our front-end projects. It
-targets Vue 3+. Please read the following instructions and checks in order to proceed.
-
-## 📦 Registry
-
-- The UI library package is available under `@flux-ui/components`.
-- The Dashboard library package is available under `@flux-ui/dashboard`.
-- The internal package is available under `@flux-ui/internals`.
-
-## ⚠️ Requirements
-
-- Install Node.js ^22
-- Install pnpm using `npm i -g pnpm`.
-- Configure a new environment variable `FONTAWESOME_NPM_AUTH_TOKEN`. This should be a valid Font Awesome private npm auth token.
-- Use `pnpm install` to install the required packages.
-- Use `pnpm dev` to start a build watcher for both targets.
-- Use `pnpm build` to build a production bundle.
-- Use `pnpm link` to link the dist folder of flux to your global node_modules.
-
-## 🪵 Git
-
-All commit messages and branches will be in English.
-
-### Branches
-
-- **Main** — Contains the latest stable release and is the exact source that is running in production.
-- **Develop** — Contains the latest staging release that is marked for deployment and is the exact source that is running on staging.
-- **Feature branches** — Any feature should have its own feature branch. Once complete, the branch should be merged into the _develop_ branch and the feature branch should be deleted.
-- **Bugfix branches** — When a bug is found, it should be fixed within a bugfix branch. Once complete the branch should be merged into the _develop_ branch and the feature branch should be deleted.
-
-### Commit messages
-
-Commit messages are bound to the following templates:
-
-- `<type>: <message> `
-- `<type>(<feature>): <message>`
-- `<type>(<feature>): <message> [<issue-number>]`
-
-#### Examples
-
-- `feat(expandable): adds header slot to expandable.`
-- `feat(expandable): adds header slot to expandable. [FLUX-123]`
-- `chore: adds vue 3 build target.`
+Contains all public types that are used in various `@flux-ui` packages.

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@flux-ui/types",
     "description": "Contains all public types of Flux UI packages.",
-    "version": "3.0.0-next.3",
+    "version": "3.0.0-next.30",
     "type": "module",
     "license": "MIT",
     "funding": "https://github.com/sponsors/basmilius",
@@ -9,21 +9,12 @@
     "repository": {
         "type": "git",
         "url": "git+https://github.com/basmilius/flux.git",
-        "directory": "packages/primitives"
+        "directory": "packages/types"
     },
     "keywords": [
-        "ui library",
-        "component library",
-        "design system",
-        "vue",
-        "vue 3",
-        "ui",
-        "components",
-        "flux"
+        "flux",
+        "types"
     ],
-    "scripts": {
-        "prepublishOnly": "cp ../../README.md ."
-    },
     "exports": {
         ".": "./src/index.ts"
     },
@@ -42,6 +33,7 @@
     "sideEffects": false,
     "dependencies": {},
     "devDependencies": {
-        "@types/luxon": "^3.6.2"
+        "@fortawesome/fontawesome-common-types": "^7.2.0",
+        "@types/luxon": "^3.7.1"
     }
 }

package/src/common.ts

@@ -1,9 +1,11 @@
-import type { FontAwesome } from './font-awesome';
-import type { MaterialSymbol } from './material-symbols';
+import type { IconName as FontAwesome } from '@fortawesome/fontawesome-common-types';
 
-export type FluxIconName = FontAwesome | MaterialSymbol;
-export type FluxFontAwesomeIconName = FontAwesome;
-export type FluxMaterialIconName = MaterialSymbol;
+export type FluxIconName = FontAwesome;
+
+export type FluxAlignment =
+    | 'start'
+    | 'center'
+    | 'end';
 
 export type FluxColor =
     | 'gray'

package/src/filter.ts

@@ -41,6 +41,7 @@ export type FluxFilterOptionHeader = {
 };
 
 export type FluxFilterOptionItem = {
+    readonly icon?: FluxIconName;
     readonly label: string;
     readonly value: FluxFilterValueSingle;
 };
@@ -60,10 +61,4 @@ export type FluxFilterValue =
     | FluxFilterValueSingle
     | FluxFilterValueSingle[];
 
-export type FluxFilterState = {
-    get resettable(): string[];
-
-    reset(): void;
-} & {
-    [key: string]: FluxFilterValue | Function;
-};
+export type FluxFilterState = Record<string, FluxFilterValue>;

package/src/form.ts

@@ -10,6 +10,8 @@ export type FluxFormSelectOption = {
     readonly command?: string;
     readonly commandIcon?: FluxIconName;
     readonly icon?: FluxIconName;
+    readonly imageAlt?: string;
+    readonly imageSrc?: string;
     readonly label: string;
     readonly selectable?: boolean;
     readonly value: string | number | null;

package/src/index.ts

@@ -1,12 +1,11 @@
 export type {
+    FluxAlignment,
     FluxAutoCompleteType,
     FluxColor,
     FluxDirection,
-    FluxFontAwesomeIconName,
     FluxIconName,
     FluxInputMask,
     FluxInputType,
-    FluxMaterialIconName,
     FluxMaybePromise,
     FluxPressableType,
     FluxSize,
@@ -56,3 +55,7 @@ export type {
     FluxSnackbarObject,
     FluxTooltipObject
 } from './notify';
+
+export type {
+    FluxStatisticsChange
+} from './statistics';

package/src/statistics.ts

@@ -0,0 +1,7 @@
+import type { FluxColor, FluxIconName } from './common';
+
+export type FluxStatisticsChange = {
+    readonly color?: FluxColor;
+    readonly icon?: FluxIconName;
+    readonly value: string | number;
+};