Dojo 樣式簡介

翻譯自：https://github.com/dojo/framework/blob/master/docs/en/styling/introduction.md

介紹

Dojo 是基于 HTML 的技術，使用 CSS 為框架中的元素和用它開發的應用程序設置樣式。

Dojo 鼓勵將結構樣式封裝在各部件中，以便最大限度復用；同時將外觀主題設置到應用程序所有部件上。用戶為他們的應用程序設置樣式和主題時，這種模式提供了固定的套路，即使混合使用 Dojo 的 @dojo/widgets 庫中的部件、由第三方提供的部件或者為特定應用程序開發的內部使用的部件時也是如此。

基本用法

注意： 以下示例是按順序在前一個示例的基礎上構建的。每個示例都盡量簡短，只突出顯示跟上一個示例相比發生變化的部分。

這些示例假定應用程序名為：

package.json

{
    "name": "my-app"
}

應用程序名與部件主題的 key 有關。

為單個部件設置樣式

• 為每個部件單獨定義一個 CSS 模塊
• 在部件的 TypeScript 代碼中使用相應的類型化的樣式類

src/styles/MyWidget.m.css

.root {
    font-family: sans-serif;
}

src/widgets/MyWidget.tsx

import { create, tsx } from '@dojo/framework/core/vdom';

import * as css from '../styles/MyWidget.m.css';

const factory = create();

export default factory(function MyWidget() {
    return <div classes={[css.root]}>My Widget</div>;
});

讓部件支持主題

• 注入 theme 中間件
• 使用 theme.classes 返回主題化的 css 類名，這樣部件的默認樣式就會被主題覆蓋

src/widgets/MyWidget.tsx

import { create, tsx } from '@dojo/framework/core/vdom';
import theme from '@dojo/framework/core/middleware/theme';

import * as css from '../styles/MyWidget.m.css';

const factory = create({ theme });

export default factory(function MyWidget({ middleware: { theme } }) {
    const { root } = theme.classes(css);
    return <div classes={[root]}>My Widget</div>;
});

創建主題

• 使用自定義的主題樣式屬性重寫部件默認的 CSS 類
• 通過合適的部件主題 key 將一個或多個重寫后的樣式鏈接到主題結構中

src/themes/MyTheme/MyWidget.m.css

.root {
    color: hotpink;
    background-color: slategray;
}

src/themes/MyTheme/theme.ts

import * as myWidgetCss from './MyWidget.m.css';

export default {
    'my-app/MyWidget': myWidgetCss
};

提取公共的主題屬性

• 導入一個集中定義的常規 CSS 文件 variables.css，其中定義了 CSS 自定義屬性
• 通過 var() 引用自定義屬性

src/themes/variables.css

:root {
    --foreground: hotpink;
    --background: slategray;
}

src/themes/MyTheme/MyWidget.m.css

@import '../variables.css';

.root {
    color: var(--foreground);
    background-color: var(--background);
}

指定默認的應用程序主題

theme 中間件可用于設置應用程序主題。要設置“默認的”或初始化主題，則使用 theme.set 函數，同時用 theme.get 函數確定是否需要設置主題。應該在應用程序的頂級部件中設置默認主題。

src/App.tsx

import { create, tsx } from '@dojo/framework/core/vdom';
import theme from '@dojo/framework/core/middleware/theme';

import myTheme from '../themes/MyTheme/theme';

const factory = create({ theme });

export default factory(function App({ middleware: { theme }}) {
    // if the theme isn't set, set the default theme
    if (!theme.get()) {
        theme.set(myTheme);
    }
    return (
        // the application's widgets
    );
});

注意： 當同時使用基于函數的部件和基于類的部件時，應該使用應用程序注冊器來注冊主題。當使用基于類的部件時（如 @dojo/widgets） 也是如此。詳情參考[基于類部件的主題]()。

更改應用程序主題

• 使用 theme 中間件 在可用的主題間切換

src/widgets/ThemeSwitcher.tsx

import { create, tsx } from '@dojo/framework/core/vdom';
import theme from '@dojo/framework/core/middleware/theme';

import myTheme from '../themes/MyTheme/theme';
import alternativeTheme from '../themes/MyAlternativeTheme/theme';

const factory = create({ theme });

export default factory(function ThemeSwitcher({ middleware: { theme } }) {
    return (
        <div>
            <button
                onclick={() => {
                    theme.set(myTheme);
                }}
            >
                Use Default Theme
            </button>
            <button
                onclick={() => {
                    theme.set(alternativeTheme);
                }}
            >
                Use Alternative Theme
            </button>
        </div>
    );
});