样式化元素

得益于 CSS 嵌套、@layer、@scope,另外浏览器的兼容性近年来已经好转,供应商私有前缀也纷纷被取消,所以不再需要 CSS Modules 类似的方案。

共享样式

使用 css 能创建可共享样式表,再使用 @adoptedStyle 应用到需要的元素即可。

import { GemElement, css, adoptedStyle, customElement } from '@mantou/gem';

// 使用 Constructable Stylesheet 创建样式表
const styles = css`
  h1 {
    text-decoration: underline;
  }
`;

@adoptedStyle(styles)
@customElement('my-element')
class MyElement extends GemElement {}

Light DOM 元素(默认)同样会受到全局样式表的影响。全局样式不能穿透 Shadow DOM,所以使用 @shadow() 的元素可以通过 CSS 变量共享样式值。

CSS in JS

可以在 JS 中引用 CSS 选择器:

import { GemElement, html, css, styled, adoptedStyle, customElement, template } from '@mantou/gem';

const styles = css({
  header: styled.class`
    text-decoration: underline;
    &:hover {
      text-decoration: none;
    }
  `,
});

@adoptedStyle(styles)
@customElement('my-element')
class MyElement extends GemElement {
  @template()
  #content = () => {
    return html`<div class=${styles.header}></div>`;
  };
}

NOTE

使用 $ 作为键代表 :host, :scope 选择器,让样式同时适用于 ShadowDOM 和 LightDOM

样式化实例

如果需要通过属性或者状态指定单个实例的样式可以:

// 省略导入...

@customElement('my-element')
@shadow()
class MyElement extends GemElement {
  @attribute color;

  @template()
  #content = () => {
    return html`
      <style>
        :host {
          --color: ${this.color}
        }
      </style>
    `;
  };
}

这个方法写法复杂且麻烦,推荐使用 createDecoratorTheme。

在元素外自定义样式

可以使用 ::part(仅限于 ShadowDOM) 导出元素内部内容,允许外部进行自定义样式:

/**
 * 下面的代码跟 `<div part="header"></div>` 效果一样,
 * 但是 Gem 推荐使用装饰器来定义 part,这样在将来能很好的进行 IDE 集成
 */

// 省略导入...

@customElement('my-element')
@shadow()
class MyElement extends GemElement {
  @part static header;

  @template()
  #content = () => {
    return html`<div part=${MyElement.header}></div>`;
  };
}

还可以使用 ElementInternals.states 导出元素内部状态,供外部对当前状态的元素样式化:

// 省略导入...

@customElement('my-element')
class MyElement extends GemElement {
  @state opened;

  open = () => {
    // 可被选择器 `:state(opened)` 选中
    this.opened = true;
  };
}

NOTE

注意跟 createState 的区别

TIP

还可以使用比较 Hack 的方式自定义元素样式,例如:

GemLinkElement[Symbol.metadata].adoptedStyleSheets.push(
  css`
    * {
      font-style: italic;
    }
  `,
);

自定义元素外部样式

Tailwind CSS

Tailwind CSS 等原子 CSS 方案适用于 Light DOM 元素(Gem 的默认模式):全局加载生成的样式表,然后在模板中直接使用工具类即可。全局工具类无法作用于使用了 @shadow() 的元素内部内容。