mirror of
https://github.com/discourse/discourse.git
synced 2024-12-04 20:56:18 +08:00
abcdd8d367
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>
|
||
|---|---|---|
| .. | ||
| client.ar.yml | ||
| client.be.yml | ||
| client.bg.yml | ||
| client.bs_BA.yml | ||
| client.ca.yml | ||
| client.cs.yml | ||
| client.da.yml | ||
| client.de.yml | ||
| client.el.yml | ||
| client.en_GB.yml | ||
| client.en.yml | ||
| client.es.yml | ||
| client.et.yml | ||
| client.fa_IR.yml | ||
| client.fi.yml | ||
| client.fr.yml | ||
| client.gl.yml | ||
| client.he.yml | ||
| client.hr.yml | ||
| client.hu.yml | ||
| client.hy.yml | ||
| client.id.yml | ||
| client.it.yml | ||
| client.ja.yml | ||
| client.ko.yml | ||
| client.lt.yml | ||
| client.lv.yml | ||
| client.nb_NO.yml | ||
| client.nl.yml | ||
| client.pl_PL.yml | ||
| client.pt_BR.yml | ||
| client.pt.yml | ||
| client.ro.yml | ||
| client.ru.yml | ||
| client.sk.yml | ||
| client.sl.yml | ||
| client.sq.yml | ||
| client.sr.yml | ||
| client.sv.yml | ||
| client.sw.yml | ||
| client.te.yml | ||
| client.th.yml | ||
| client.tr_TR.yml | ||
| client.uk.yml | ||
| client.ur.yml | ||
| client.vi.yml | ||
| client.zh_CN.yml | ||
| client.zh_TW.yml | ||
| server.ar.yml | ||
| server.be.yml | ||
| server.bg.yml | ||
| server.bs_BA.yml | ||
| server.ca.yml | ||
| server.cs.yml | ||
| server.da.yml | ||
| server.de.yml | ||
| server.el.yml | ||
| server.en_GB.yml | ||
| server.en.yml | ||
| server.es.yml | ||
| server.et.yml | ||
| server.fa_IR.yml | ||
| server.fi.yml | ||
| server.fr.yml | ||
| server.gl.yml | ||
| server.he.yml | ||
| server.hr.yml | ||
| server.hu.yml | ||
| server.hy.yml | ||
| server.id.yml | ||
| server.it.yml | ||
| server.ja.yml | ||
| server.ko.yml | ||
| server.lt.yml | ||
| server.lv.yml | ||
| server.nb_NO.yml | ||
| server.nl.yml | ||
| server.pl_PL.yml | ||
| server.pt_BR.yml | ||
| server.pt.yml | ||
| server.ro.yml | ||
| server.ru.yml | ||
| server.sk.yml | ||
| server.sl.yml | ||
| server.sq.yml | ||
| server.sr.yml | ||
| server.sv.yml | ||
| server.sw.yml | ||
| server.te.yml | ||
| server.th.yml | ||
| server.tr_TR.yml | ||
| server.uk.yml | ||
| server.ur.yml | ||
| server.vi.yml | ||
| server.zh_CN.yml | ||
| server.zh_TW.yml | ||