mirror of
https://github.com/discourse/discourse.git
synced 2024-12-03 04:03:45 +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>
|
||
|---|---|---|
| .. | ||
| chat-channel-card-test.js | ||
| chat-channel-leave-btn-test.js | ||
| chat-channel-metadata-test.js | ||
| chat-channel-preview-card-test.js | ||
| chat-channel-row-test.js | ||
| chat-channel-settings-saved-indicator-test.js | ||
| chat-channel-settings-view-test.js | ||
| chat-channel-status-test.js | ||
| chat-channel-test.js | ||
| chat-channel-title-test.js | ||
| chat-composer-dropdown-test.js | ||
| chat-composer-message-details-test.js | ||
| chat-composer-placeholder-test.js | ||
| chat-composer-upload-test.js | ||
| chat-composer-uploads-test.js | ||
| chat-emoji-avatar-test.js | ||
| chat-emoji-picker-test.js | ||
| chat-header-icon-test.js | ||
| chat-message-avatar-test.js | ||
| chat-message-collapser-test.js | ||
| chat-message-info-test.js | ||
| chat-message-left-gutter-test.js | ||
| chat-message-reaction-test.js | ||
| chat-message-separator-date-test.js | ||
| chat-message-separator-new-test.js | ||
| chat-message-test.js | ||
| chat-message-text-test.js | ||
| chat-modal-archive-channel-test.js | ||
| chat-modal-delete-channel-test.js | ||
| chat-modal-move-message-to-channel-test.js | ||
| chat-notices-test.js | ||
| chat-replying-indicator-test.js | ||
| chat-retention-reminder-test.js | ||
| chat-retention-reminder-text-test.js | ||
| chat-thread-participants-test.js | ||
| chat-upload-test.js | ||
| chat-user-avatar-test.js | ||
| chat-user-card-button-test.js | ||
| chat-user-display-name-test.js | ||
| chat-user-info-test.js | ||
| collapser-test.js | ||
| dc-filter-input-test.js | ||