@lexibase/rdx-types 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/config.d.ts +7 -3
  2. package/package.json +1 -1
package/dist/config.d.ts CHANGED
@@ -68,12 +68,16 @@ export type RDXConfig = {
68
68
  */
69
69
  title?: string
70
70
  /**
71
- * Imported React component accepting an optional className for styling.
72
- * Pass the component itself, not JSX or an image path. Defaults to the RDX logo.
71
+ * Image URL from public/, e.g. '/images/logo.png' or '/images/logo.svg',
72
+ * or an imported React component accepting className. Pass the component
73
+ * itself rather than JSX. Defaults to the RDX logo.
74
+ * Images retain their proportions and original colors in both themes.
75
+ * @example
76
+ * logo: '/images/logo.png'
73
77
  * @example
74
78
  * logo: MyLogo
75
79
  */
76
- logo?: ComponentType<{ className?: string }>
80
+ logo?: string | ComponentType<{ className?: string }>
77
81
  /** Optional GitHub link and theme toggle. Omitted actions remain hidden. */
78
82
  actions?: {
79
83
  /** Show the system/light/dark theme switcher in the navbar. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lexibase/rdx-types",
3
- "version": "2.1.0",
3
+ "version": "2.2.0",
4
4
  "license": "MIT",
5
5
  "description": "Shared TypeScript types for RDX documentation projects.",
6
6
  "types": "./dist/index.d.ts",