Dojo 样式简介

简介

Dojo 是基于 HTML 的技术，使用 CSS 为框架中的元素和用它开发的应用程序设置样式。

Dojo 鼓励将结构样式封装在各部件中，以便最大限度复用；同时将外观主题设置到应用程序全部部件上。用户为他们的应用程序设置样式和主题时，这种模式提供了固定的套路，即便混合使用 Dojo 的 @dojo/widgets 库中的部件、由第三方提供的部件或者为特定应用程序开发的内部使用的部件时也是如此。

功能	描述
为单个部件设置样式	CSS Modules 用于定义，在单个部件的做用域内有效的样式，避免潜在的交叉污染和样式冲突。经过类型化的 CSS 模块导入和 IDE 自动完成功能，部件能够精确的引用 CSS 类名。
强大的主题支持	能够轻松开发出支持主题的部件，这样的部件既能使用简化的、中心化的应用程序主题，也能调整或覆盖单个实例的目标样式（若是须要的话）。CLI 工具支持分发自定义主题。
响应式的主题变动	与 Dojo 应用程序中的其余响应式状态变动相似，当一个部件或者整个应用程序的主题发生变化时，只有受影响的部件才会从新渲染。
提取 CSS 属性	每一个 CSS 模块可经过 CSS 自定义属性和 var() 引用集中定义的 :root 样式变量。
简化定义第三方部件的主题	应用程序能够轻松扩展主题以覆盖第三方部件，如 Dojo 内置部件库中的部件，Dojo 也提供了开箱即用的主题，应用程序可直接使用。CLI 工具极大简化了主题的建立和组合。

基本用法

注意： 如下示例是按顺序在前一个示例的基础上构建的。每一个示例都尽可能简短，只突出显示跟上一个示例相比发生变化的部分。

这些示例假定应用程序名为：

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>
    );
});