mirror of
https://github.com/discourse/discourse.git
synced 2025-05-23 11:12:40 +08:00
DEV: FloatKit (#23312)
This PR introduces three new UI elements to Discourse codebase through an addon called "FloatKit":
- menu
- tooltip
- toast
Simple cases can be express with an API similar to DButton:
```hbs
<DTooltip
@label={{i18n "foo.bar"}}
@icon="check"
@content="Something"
/>
```
More complex cases can use blocks:
```hbs
<DTooltip>
<:trigger>
{{d-icon "check"}}
<span>{{i18n "foo.bar"}}</span>
</:trigger>
<:content>
Something
</:content>
</DTooltip>
```
You can manually show a tooltip using the `tooltip` service:
```javascript
const tooltipInstance = await this.tooltip.show(
document.querySelector(".my-span"),
options
)
// and later manually close or destroy it
tooltipInstance.close();
tooltipInstance.destroy();
// you can also just close any open tooltip through the service
this.tooltip.close();
```
The service also allows you to register event listeners on a trigger, it removes the need for you to manage open/close of a tooltip started through the service:
```javascript
const tooltipInstance = this.tooltip.register(
document.querySelector(".my-span"),
options
)
// when done you can destroy the instance to remove the listeners
tooltipInstance.destroy();
```
Note that the service also allows you to use a custom component as content which will receive `@data` and `@close` as args:
```javascript
const tooltipInstance = await this.tooltip.show(
document.querySelector(".my-span"),
{
component: MyComponent,
data: { foo: 1 }
}
)
```
Menus are very similar to tooltips and provide the same kind of APIs:
```hbs
<DMenu @icon="plus" @label={{i18n "foo.bar"}}>
<ul>
<li>Foo</li>
<li>Bat</li>
<li>Baz</li>
</ul>
</DMenu>
```
They also support blocks:
```hbs
<DMenu>
<:trigger>
{{d-icon "plus"}}
<span>{{i18n "foo.bar"}}</span>
</:trigger>
<:content>
<ul>
<li>Foo</li>
<li>Bat</li>
<li>Baz</li>
</ul>
</:content>
</DMenu>
```
You can manually show a menu using the `menu` service:
```javascript
const menuInstance = await this.menu.show(
document.querySelector(".my-span"),
options
)
// and later manually close or destroy it
menuInstance.close();
menuInstance.destroy();
// you can also just close any open tooltip through the service
this.menu.close();
```
The service also allows you to register event listeners on a trigger, it removes the need for you to manage open/close of a tooltip started through the service:
```javascript
const menuInstance = this.menu.register(
document.querySelector(".my-span"),
options
)
// when done you can destroy the instance to remove the listeners
menuInstance.destroy();
```
Note that the service also allows you to use a custom component as content which will receive `@data` and `@close` as args:
```javascript
const menuInstance = await this.menu.show(
document.querySelector(".my-span"),
{
component: MyComponent,
data: { foo: 1 }
}
)
```
Interacting with toasts is made only through the `toasts` service.
A default component is provided (DDefaultToast) and can be used through dedicated service methods:
- this.toasts.success({ ... });
- this.toasts.warning({ ... });
- this.toasts.info({ ... });
- this.toasts.error({ ... });
- this.toasts.default({ ... });
```javascript
this.toasts.success({
data: {
title: "Foo",
message: "Bar",
actions: [
{
label: "Ok",
class: "btn-primary",
action: (componentArgs) => {
// eslint-disable-next-line no-alert
alert("Closing toast:" + componentArgs.data.title);
componentArgs.close();
},
}
]
},
});
```
You can also provide your own component:
```javascript
this.toasts.show(MyComponent, {
autoClose: false,
class: "foo",
data: { baz: 1 },
})
```
Co-authored-by: Martin Brennan <mjrbrennan@gmail.com>
Co-authored-by: Isaac Janzen <50783505+janzenisaac@users.noreply.github.com>
Co-authored-by: David Taylor <david@taylorhq.com>
Co-authored-by: Jarek Radosz <jradosz@gmail.com>
This commit is contained in:
Joffrey JAFFEUX
198
app/assets/javascripts/float-kit/addon/lib/float-kit-instance.js
Normal file
198
app/assets/javascripts/float-kit/addon/lib/float-kit-instance.js
Normal file
@ -0,0 +1,198 @@
|
||||
import { action } from "@ember/object";
|
||||
import { cancel, next } from "@ember/runloop";
|
||||
import { tracked } from "@glimmer/tracking";
|
||||
import discourseLater from "discourse-common/lib/later";
|
||||
import { makeArray } from "discourse-common/lib/helpers";
|
||||
import { bind } from "discourse-common/utils/decorators";
|
||||
|
||||
const TOUCH_OPTIONS = { passive: true, capture: true };
|
||||
|
||||
function cancelEvent(event) {
|
||||
event.preventDefault();
|
||||
event.stopImmediatePropagation();
|
||||
}
|
||||
|
||||
export default class FloatKitInstance {
|
||||
@tracked expanded = false;
|
||||
@tracked id = null;
|
||||
|
||||
trigger = null;
|
||||
content = null;
|
||||
|
||||
@action
|
||||
async show() {
|
||||
this.expanded = true;
|
||||
|
||||
await new Promise((resolve) => next(resolve));
|
||||
}
|
||||
|
||||
@action
|
||||
async close() {
|
||||
this.expanded = false;
|
||||
|
||||
await new Promise((resolve) => next(resolve));
|
||||
}
|
||||
|
||||
@action
|
||||
onFocus(event) {
|
||||
this.onTrigger(event);
|
||||
}
|
||||
|
||||
@action
|
||||
onBlur(event) {
|
||||
this.onTrigger(event);
|
||||
}
|
||||
|
||||
@action
|
||||
onFocusIn(event) {
|
||||
this.onTrigger(event);
|
||||
}
|
||||
|
||||
@action
|
||||
onFocusOut(event) {
|
||||
this.onTrigger(event);
|
||||
}
|
||||
|
||||
@action
|
||||
onTouchStart(event) {
|
||||
if (event.touches.length > 1) {
|
||||
this.onTouchCancel();
|
||||
return;
|
||||
}
|
||||
|
||||
event.stopPropagation();
|
||||
|
||||
this.trigger.addEventListener(
|
||||
"touchmove",
|
||||
this.onTouchCancel,
|
||||
TOUCH_OPTIONS
|
||||
);
|
||||
this.trigger.addEventListener(
|
||||
"touchcancel",
|
||||
this.onTouchCancel,
|
||||
TOUCH_OPTIONS
|
||||
);
|
||||
this.trigger.addEventListener(
|
||||
"touchend",
|
||||
this.onTouchCancel,
|
||||
TOUCH_OPTIONS
|
||||
);
|
||||
this.touchTimeout = discourseLater(() => {
|
||||
if (this.isDestroying || this.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.trigger.addEventListener("touchend", cancelEvent, {
|
||||
once: true,
|
||||
capture: true,
|
||||
});
|
||||
|
||||
this.onTrigger(event);
|
||||
}, 500);
|
||||
}
|
||||
|
||||
@bind
|
||||
onTouchCancel() {
|
||||
cancel(this.touchTimeout);
|
||||
|
||||
this.trigger.removeEventListener("touchmove", this.onTouchCancel);
|
||||
this.trigger.removeEventListener("touchend", this.onTouchCancel);
|
||||
this.trigger.removeEventListener("touchcancel", this.onTouchCancel);
|
||||
}
|
||||
|
||||
tearDownListeners() {
|
||||
if (!this.options.listeners) {
|
||||
return;
|
||||
}
|
||||
|
||||
makeArray(this.triggers)
|
||||
.filter(Boolean)
|
||||
.forEach((trigger) => {
|
||||
switch (trigger) {
|
||||
case "hold":
|
||||
this.trigger.addEventListener("touchstart", this.onTouchStart);
|
||||
break;
|
||||
case "focus":
|
||||
this.trigger.removeEventListener("focus", this.onFocus);
|
||||
this.trigger.removeEventListener("blur", this.onBlur);
|
||||
break;
|
||||
case "focusin":
|
||||
this.trigger.removeEventListener("focusin", this.onFocusIn);
|
||||
this.trigger.removeEventListener("focusout", this.onFocusOut);
|
||||
break;
|
||||
case "hover":
|
||||
this.trigger.removeEventListener("mousemove", this.onMouseMove);
|
||||
if (!this.options.interactive) {
|
||||
this.trigger.removeEventListener("mouseleave", this.onMouseLeave);
|
||||
}
|
||||
|
||||
break;
|
||||
case "click":
|
||||
this.trigger.removeEventListener("click", this.onClick);
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
cancel(this.touchTimeout);
|
||||
}
|
||||
|
||||
setupListeners() {
|
||||
if (!this.options.listeners) {
|
||||
return;
|
||||
}
|
||||
|
||||
makeArray(this.triggers)
|
||||
.filter(Boolean)
|
||||
.forEach((trigger) => {
|
||||
switch (trigger) {
|
||||
case "hold":
|
||||
this.trigger.addEventListener(
|
||||
"touchstart",
|
||||
this.onTouchStart,
|
||||
TOUCH_OPTIONS
|
||||
);
|
||||
break;
|
||||
case "focus":
|
||||
this.trigger.addEventListener("focus", this.onFocus, {
|
||||
passive: true,
|
||||
});
|
||||
this.trigger.addEventListener("blur", this.onBlur, {
|
||||
passive: true,
|
||||
});
|
||||
break;
|
||||
case "focusin":
|
||||
this.trigger.addEventListener("focusin", this.onFocusIn, {
|
||||
passive: true,
|
||||
});
|
||||
this.trigger.addEventListener("focusout", this.onFocusOut, {
|
||||
passive: true,
|
||||
});
|
||||
break;
|
||||
case "hover":
|
||||
this.trigger.addEventListener("mousemove", this.onMouseMove, {
|
||||
passive: true,
|
||||
});
|
||||
if (!this.options.interactive) {
|
||||
this.trigger.addEventListener("mouseleave", this.onMouseLeave, {
|
||||
passive: true,
|
||||
});
|
||||
}
|
||||
|
||||
break;
|
||||
case "click":
|
||||
this.trigger.addEventListener("click", this.onClick, {
|
||||
passive: true,
|
||||
});
|
||||
break;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
get triggers() {
|
||||
return this.options.triggers ?? ["click"];
|
||||
}
|
||||
|
||||
get untriggers() {
|
||||
return this.options.untriggers ?? ["click"];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user