diff --git a/src/components/super/i-static-page/modules/theme/README.md b/src/components/super/i-static-page/modules/theme/README.md index 3d9da0d0c1..3823e2a26e 100644 --- a/src/components/super/i-static-page/modules/theme/README.md +++ b/src/components/super/i-static-page/modules/theme/README.md @@ -93,7 +93,24 @@ module.exports = config.createConfig({dirs: [__dirname, 'client']}, { ## Accessors -## current +### availableThemes + +A set of available app themes. + +```typescript +import iBlock, { component, prop, field } from 'components/super/i-block/i-block'; + +@component() +export default class bExample extends iBlock { + created() { + console.log(this.r.theme.availableThemes); + } +} +``` + +## Methods + +### get Current theme value. @@ -103,14 +120,29 @@ import iBlock, { component, prop, field } from 'components/super/i-block/i-block @component() export default class bExample extends iBlock { created() { - console.log(this.r.theme.current); + console.log(this.r.theme.get()); } } ``` -## availableThemes +### set -A set of available app themes. +Sets a new value for the current theme + +```typescript +import iBlock, { component, prop, field } from 'components/super/i-block/i-block'; + +@component() +export default class bExample extends iBlock { + changeTheme(value: 'dark' | 'light') { + this.r.theme.set(value); + } +} +``` + +### useSystem + +Sets the actual system theme and activates the system theme change listener ```typescript import iBlock, { component, prop, field } from 'components/super/i-block/i-block'; @@ -118,7 +150,7 @@ import iBlock, { component, prop, field } from 'components/super/i-block/i-block @component() export default class bExample extends iBlock { created() { - console.log(this.r.theme.availableThemes); + this.r.theme.useSystem(); } } ``` diff --git a/src/components/super/i-static-page/modules/theme/system-theme-extractor/README.md b/src/components/super/i-static-page/modules/theme/system-theme-extractor/README.md index d38f02e35d..b0bb7c1c7c 100644 --- a/src/components/super/i-static-page/modules/theme/system-theme-extractor/README.md +++ b/src/components/super/i-static-page/modules/theme/system-theme-extractor/README.md @@ -9,7 +9,7 @@ By default, the engine for the web is supported. The engine needs to be passed to the `themeManager` constructor. ```ts -import { webEngineFactory } from 'core/system-theme-extractor/engines/web'; +import { webEngineFactory } from 'components/super/i-static-page/modules/theme/system-theme-extractor/engines/web'; class iRoot extends iStaticPage { @system((o) => themeManagerFactory( @@ -24,8 +24,8 @@ class iRoot extends iStaticPage { Also, you can implement your own engine. ```ts -// src/core/system-theme-extractor/engines/custom/index.ts -import type { SystemThemeExtractor } from 'core/system-theme-extractor'; +// src/components/super/i-static-page/modules/theme/system-theme-extractor/engines/custom/index.ts +import type { SystemThemeExtractor } from 'components/super/i-static-page/modules/theme/system-theme-extractor'; export default class CustomEngine implements SystemThemeExtractor { // Implement all necessary methods of the interface here.