fune/toolkit/content/widgets/moz-button-group/moz-button-group.mjs
Hanna Jones eb9fd58f2b Bug 1799699 - expand storybook args table docs r=mstriemer,tgiles
This is still far from perfect given the limitations of the Storybook web components package, but I figured this was worth putting up since it's still an improvement over the current state of our args tables (I think).

I'm mostly leaving the default generated `custom-elements-manifest.json` alone save for filtering some internal properties we don't want documented since they shouldn't really be accessed directly. If it seems too strange to just have the `aria-label` attr documented we could possibly remove `attributes` from the docs for now (this happens because it's the only attr where the name is different from the property name).

Open to feedback/thoughts on if this is useful or too wonky for now given the weirdness around how Storybook creates naming collisions.

Differential Revision: https://phabricator.services.mozilla.com/D162599
2023-01-23 23:52:36 +00:00

88 lines
2.6 KiB
JavaScript

/* 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 { html } from "chrome://global/content/vendor/lit.all.mjs";
import { MozLitElement } from "chrome://global/content/lit-utils.mjs";
export const PLATFORM_LINUX = "linux";
export const PLATFORM_MACOS = "macosx";
export const PLATFORM_WINDOWS = "win";
/**
* A grouping of buttons. Primary button order will be set automatically based
* on class="primary", type="submit" or autofocus attribute. Set slot="primary"
* on a primary button that does not have primary styling to set its position.
*
* @tagname moz-button-group
* @property {string} platform - The detected platform, set automatically.
*/
export default class MozButtonGroup extends MozLitElement {
static queries = {
defaultSlotEl: "slot:not([name])",
primarySlotEl: "slot[name=primary]",
};
static properties = {
platform: { state: true },
};
// Use a relative URL in storybook to get faster reloads on style changes.
static stylesheetUrl = window.IS_STORYBOOK
? "./moz-button-group/moz-button-group.css"
: "chrome://global/content/elements/moz-button-group.css";
constructor() {
super();
this.#detectPlatform();
}
#detectPlatform() {
if (typeof AppConstants !== "undefined") {
this.platform = AppConstants.platform;
} else if (navigator.platform.includes("Linux")) {
this.platform = PLATFORM_LINUX;
} else if (navigator.platform.includes("Mac")) {
this.platform = PLATFORM_MACOS;
} else {
this.platform = PLATFORM_WINDOWS;
}
}
onSlotchange(e) {
for (let child of this.defaultSlotEl.assignedNodes()) {
if (!(child instanceof Element)) {
// Text nodes won't support classList or getAttribute.
continue;
}
// Bug 1791816: These should check moz-button instead of button.
if (
child.localName == "button" &&
(child.classList.contains("primary") ||
child.getAttribute("type") == "submit" ||
child.hasAttribute("autofocus"))
) {
child.slot = "primary";
}
}
}
render() {
let slots = [
html`
<slot @slotchange=${this.onSlotchange}></slot>
`,
html`
<slot name="primary"></slot>
`,
];
if (this.platform == PLATFORM_WINDOWS) {
slots = [slots[1], slots[0]];
}
return html`
<link rel="stylesheet" href=${this.constructor.stylesheetUrl} />
${slots}
`;
}
}
customElements.define("moz-button-group", MozButtonGroup);