summaryrefslogtreecommitdiffstats
path: root/browser/components/storybook/.storybook/preview.mjs
blob: 55e7f00f10389d63a2a1cae0f7630c30ff8ea397 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

import { css, html } from "lit.all.mjs";
import { MozLitElement } from "toolkit/content/widgets/lit-utils.mjs";
import { setCustomElementsManifest } from "@storybook/web-components";
import customElementsManifest from "../custom-elements.json";
import { insertFTLIfNeeded, connectFluent } from "./fluent-utils.mjs";

// Base Fluent set up.
connectFluent();

// Any fluent imports should go through MozXULElement.insertFTLIfNeeded.
window.MozXULElement = {
  insertFTLIfNeeded,

  // For some reason Storybook doesn't watch the static folder. By creating a
  // method with a dynamic import we can pull the desired files into the bundle.
  async importCss(resourceName) {
    // eslint-disable-next-line no-unsanitized/method
    let file = await import(
      /* webpackInclude: /.*[\/\\].*\.css$/ */
      `browser/themes/shared/${resourceName}`
    );
    // eslint-disable-next-line no-unsanitized/method
    file = await import(
      /* webpackInclude: /.*[\/\\].*\.css$/ */
      `browser/components/firefoxview/${resourceName}`
    );
    return file;
  },
};

/**
 * Wrapper component used to decorate all of our stories by providing access to
 * `in-content/common.css` without leaking styles that conflict Storybook's CSS.
 *
 * More information on decorators can be found at:
 * https://storybook.js.org/docs/web-components/writing-stories/decorators
 *
 * @property {Function} story
 *  Storybook uses this internally to render stories. We call `story` in our
 *  render function so that the story contents have the same shadow root as
 *  `with-common-styles` and styles from `in-content/common` get applied.
 * @property {Object} context
 *  Another Storybook provided property containing additional data stories use
 *  to render. If we don't make this a reactive property Lit seems to optimize
 *  away any re-rendering of components inside `with-common-styles`.
 */
class WithCommonStyles extends MozLitElement {
  static styles = css`
    :host {
      display: block;
      height: 100%;
      padding: 1rem;
      box-sizing: border-box;
    }

    :host,
    :root {
      font: message-box;
      appearance: none;
      background-color: var(--in-content-page-background);
      color: var(--in-content-page-color);
      -moz-box-layout: flex;
    }

    :host,
    :root:not(.system-font-size) {
      font-size: 15px;
    }
  `;

  static properties = {
    story: { type: Function },
    context: { type: Object },
  };

  storyContent() {
    if (this.story) {
      return this.story();
    }
    return html` <slot></slot> `;
  }

  render() {
    return html`
      <link
        rel="stylesheet"
        href="chrome://global/skin/in-content/common.css"
      />
      ${this.storyContent()}
    `;
  }
}
customElements.define("with-common-styles", WithCommonStyles);

// Wrap all stories in `with-common-styles`.
export const decorators = [
  (story, context) =>
    html`
      <with-common-styles
        .story=${story}
        .context=${context}
      ></with-common-styles>
    `,
];

// Enable props tables documentation.
setCustomElementsManifest(customElementsManifest);