mirror of
https://github.com/discourse/discourse.git
synced 2024-12-02 10:53:43 +08:00
2a10ea0e3f
This PR introduces three new concepts to Discourse codebase through an addon called "FloatKit":
- menu
- tooltip
- toast
## Tooltips
### Component
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>
```
### Service
You can manually show a tooltip using the `tooltip` service:
```javascript
const tooltipInstance = await this.tooltip.show(
document.querySelector(".my-span"),
options
)
// and later manual 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
Menus are very similar to tooltips and provide the same kind of APIs:
### Component
```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>
```
### Service
You can manually show a menu using the `menu` service:
```javascript
const menuInstance = await this.menu.show(
document.querySelector(".my-span"),
options
)
// and later manual 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 }
}
)
```
## Toasts
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>
121 lines
3.7 KiB
JavaScript
121 lines
3.7 KiB
JavaScript
import Service from "@ember/service";
|
|
import { getOwner } from "@ember/application";
|
|
import { action } from "@ember/object";
|
|
import DTooltipInstance from "float-kit/lib/d-tooltip-instance";
|
|
import { guidFor } from "@ember/object/internals";
|
|
import { tracked } from "@glimmer/tracking";
|
|
import { updatePosition } from "float-kit/lib/update-position";
|
|
|
|
export default class Tooltip extends Service {
|
|
@tracked activeTooltip;
|
|
@tracked portalOutletElement;
|
|
|
|
/**
|
|
* Render a tooltip
|
|
*
|
|
* @param {Element | DTooltipInstance}
|
|
* - trigger - the element that triggered the tooltip, can also be an object implementing `getBoundingClientRect`
|
|
* - tooltip - an instance of a tooltip
|
|
* @param {Object} [options] - options, if trigger given as first argument
|
|
* @param {String | Element | Component} [options.content] - Specifies the content of the tooltip
|
|
* @param {Integer} [options.maxWidth] - Specifies the maximum width of the content
|
|
* @param {Object} [options.data] - An object which will be passed as the `@data` argument when content is a `Component`
|
|
* @param {Boolean} [options.arrow] - Determines if the tooltip has an arrow
|
|
* @param {Boolean} [options.offset] - Displaces the content from its reference trigger in pixels
|
|
* @param {String} [options.identifier] - Add a data-identifier attribute to the trigger and the content
|
|
* @param {Boolean} [options.inline] - Improves positioning for trigger that spans over multiple lines
|
|
*
|
|
* @returns {Promise<DTooltipInstance>}
|
|
*/
|
|
@action
|
|
async show() {
|
|
let instance;
|
|
|
|
if (arguments[0] instanceof DTooltipInstance) {
|
|
instance = arguments[0];
|
|
|
|
if (this.activeTooltip === instance && this.activeTooltip.expanded) {
|
|
return;
|
|
}
|
|
} else {
|
|
const trigger = arguments[0];
|
|
if (
|
|
this.activeTooltip &&
|
|
this.activeTooltip.id ===
|
|
(trigger?.id?.length ? trigger.id : guidFor(trigger)) &&
|
|
this.activeTooltip.expanded
|
|
) {
|
|
this.activeTooltip?.close();
|
|
return;
|
|
}
|
|
|
|
instance = new DTooltipInstance(getOwner(this), trigger, arguments[1]);
|
|
}
|
|
|
|
await this.replace(instance);
|
|
instance.expanded = true;
|
|
return instance;
|
|
}
|
|
|
|
/**
|
|
* Replaces any active tooltip
|
|
*/
|
|
@action
|
|
async replace(tooltip) {
|
|
await this.activeTooltip?.close();
|
|
this.activeTooltip = tooltip;
|
|
}
|
|
|
|
/**
|
|
* Closes the active tooltip
|
|
* @param {DTooltipInstance} [tooltip] - the tooltip to close, if not provider will close any active tooltip
|
|
*/
|
|
@action
|
|
async close(tooltip) {
|
|
if (this.activeTooltip && tooltip && this.activeTooltip.id !== tooltip.id) {
|
|
return;
|
|
}
|
|
|
|
await this.activeTooltip?.close();
|
|
this.activeTooltip = null;
|
|
}
|
|
|
|
/**
|
|
* Update the tooltip position
|
|
* @param {DTooltipInstance} [tooltip] - the tooltip to update, if not provider will update any active tooltip
|
|
*/
|
|
@action
|
|
async update(tooltip) {
|
|
const instance = tooltip || this.activeTooltip;
|
|
if (!instance) {
|
|
return;
|
|
}
|
|
await updatePosition(instance.trigger, instance.content, instance.options);
|
|
await instance.show();
|
|
}
|
|
|
|
/**
|
|
* Register event listeners on a trigger to show a tooltip
|
|
*
|
|
* @param {Element} trigger - the element that triggered the tooltip, can also be an object implementing `getBoundingClientRect`
|
|
* @param {Object} [options] - @see `show`
|
|
*
|
|
* @returns {DTooltipInstance} An instance of the tooltip
|
|
*/
|
|
@action
|
|
register(trigger, options = {}) {
|
|
return new DTooltipInstance(getOwner(this), trigger, {
|
|
...options,
|
|
listeners: true,
|
|
beforeTrigger: async (tooltip) => {
|
|
await this.replace(tooltip);
|
|
},
|
|
});
|
|
}
|
|
|
|
@action
|
|
registerPortalOutletElement(element) {
|
|
this.portalOutletElement = element;
|
|
}
|
|
}
|