colorsbymax 0.1.1 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "colorsbymax",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "A live theme switcher for any website: site themes, 700+ palettes, for light/dark modes and WCAG contrast checks.",
   "keywords": [
     "theme",
@@ -32,6 +32,9 @@
     "*": {
       "pdf": [
         "./types/pdf.d.ts"
+      ],
+      "auto": [
+        "./types/auto.d.ts"
       ]
     }
   },
@@ -41,6 +44,11 @@
       "import": "./dist/index.js",
       "default": "./dist/index.js"
     },
+    "./auto": {
+      "types": "./types/auto.d.ts",
+      "import": "./dist/auto.js",
+      "default": "./dist/auto.js"
+    },
     "./pdf": {
       "types": "./types/pdf.d.ts",
       "import": "./dist/pdf.js",
@@ -49,17 +57,21 @@
     "./tokens.css": "./src/tokens.css",
     "./package.json": "./package.json"
   },
-  "sideEffects": false,
+  "sideEffects": [
+    "./dist/auto.js"
+  ],
   "engines": {
     "node": ">=18"
   },
   "files": [
     "dist",
     "types/index.d.ts",
+    "types/auto.d.ts",
     "types/pdf.d.ts",
     "src/tokens.css",
     "LICENSE",
-    "THIRD_PARTY_NOTICES.md"
+    "THIRD_PARTY_NOTICES.md",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "dev": "vite",

package/types/auto.d.ts

@@ -0,0 +1,10 @@
+// Type declarations for 'colorsbymax/auto'. Importing the module mounts the colour button by
+// itself once the page has rendered: `import 'colorsbymax/auto'`.
+
+import type { ColorsByMaxConfig } from './index.js'
+
+/**
+ * Mounts the colour button and panel with settings, instead of the automatic mount. Calling it
+ * again replaces the previous mount. Returns a function that removes it.
+ */
+export function autoMount(config?: ColorsByMaxConfig): () => void

package/types/index.d.ts

@@ -69,6 +69,22 @@ export interface ColorsByMaxConfig {
   scrollbars?: boolean
   /** Enables PDF uploads: pass `loadPdf` from 'colorsbymax/pdf' (needs pdfjs-dist installed). */
   pdf?: () => Promise<unknown>
+  /**
+   * Re-colour a site that doesn't paint with the --color-* variables, by swapping the colours
+   * actually on the page. 'auto' (the default) does it only when the site doesn't define
+   * --color-primary itself; false never does.
+   */
+  recolour?: boolean | 'auto'
+  /**
+   * Where the colour button starts. Default 'bottom-right', like chat and help widgets;
+   * 'top-right' sits just under a floating nav bar. Visitors can still drag it anywhere.
+   */
+  position?: 'bottom-right' | 'bottom-left' | 'top-left' | 'top-right'
+  /**
+   * Hide the colour button and panel; the theme still applies. `hidden: import.meta.env.PROD`
+   * keeps it out of production once the colours are chosen, while it still shows in development.
+   */
+  hidden?: boolean
 }
 
 export interface ThemeProviderProps {
@@ -102,6 +118,13 @@ export interface ThemeApi {
   siteName: string
   usage: Partial<Record<TokenKey, string>>
   loadPdf: (() => Promise<unknown>) | null
+  position: 'bottom-right' | 'bottom-left' | 'top-left' | 'top-right'
+  /** True when the config hides the switcher; the theme still applies. */
+  hidden: boolean
+  /** True when colorsbymax is swapping the page's own colours (the site isn't using the variables). */
+  recolouring: boolean
+  /** Turns re-colouring of the site's logo on or off. */
+  setLogoColouring(on: boolean): void
   /** The site's own themes, then any scan suggestions. */
   siteThemes: Theme[]
   defaultTheme: Theme
@@ -170,6 +193,10 @@ export interface PanelSettings {
   panelWidth: number | null
   panelHeight: number | 'full' | null
   libraryCollapsed: boolean
+  /** Whether themes re-colour the site's logo too. Off (the default) keeps its own colours. */
+  colourLogo: boolean
+  /** Hidden on this device (from the finish screen); Alt+Shift+C or ?colorsbymax brings it back. */
+  hideButton: boolean
 }
 /** The visitor settings the panel starts with. */
 export const DEFAULT_SETTINGS: PanelSettings