mirror of
https://github.com/discourse/discourse.git
synced 2024-12-03 19:15:48 +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>
|
||
|---|---|---|
| .. | ||
| base-common.scss | ||
| chat-browse.scss | ||
| chat-channel-card.scss | ||
| chat-channel-info.scss | ||
| chat-channel-preview-card.scss | ||
| chat-channel-row.scss | ||
| chat-channel-settings-saved-indicator.scss | ||
| chat-channel-title.scss | ||
| chat-channel.scss | ||
| chat-composer-button.scss | ||
| chat-composer-dropdown.scss | ||
| chat-composer-separator.scss | ||
| chat-composer-upload.scss | ||
| chat-composer-uploads.scss | ||
| chat-composer.scss | ||
| chat-drawer.scss | ||
| chat-emoji-picker.scss | ||
| chat-form.scss | ||
| chat-height-mixin.scss | ||
| chat-index.scss | ||
| chat-mention-warnings.scss | ||
| chat-message-actions.scss | ||
| chat-message-collapser.scss | ||
| chat-message-creator.scss | ||
| chat-message-error.scss | ||
| chat-message-images.scss | ||
| chat-message-info.scss | ||
| chat-message-left-gutter.scss | ||
| chat-message-separator.scss | ||
| chat-message-thread-indicator.scss | ||
| chat-message.scss | ||
| chat-modal-archive-channel.scss | ||
| chat-modal-channel-summary.scss | ||
| chat-modal-create-channel.scss | ||
| chat-modal-edit-channel-description.scss | ||
| chat-modal-move-message-to-channel.scss | ||
| chat-modal-new-message.scss | ||
| chat-notices.scss | ||
| chat-onebox.scss | ||
| chat-reply.scss | ||
| chat-replying-indicator.scss | ||
| chat-scroll-to-bottom.scss | ||
| chat-section.scss | ||
| chat-selection-manager.scss | ||
| chat-side-panel-resizer.scss | ||
| chat-side-panel.scss | ||
| chat-skeleton.scss | ||
| chat-tabs.scss | ||
| chat-thread-header-buttons.scss | ||
| chat-thread-header.scss | ||
| chat-thread-list-header.scss | ||
| chat-thread-list-item.scss | ||
| chat-thread-participants.scss | ||
| chat-thread-unread-indicator.scss | ||
| chat-thread.scss | ||
| chat-threads-list.scss | ||
| chat-transcript.scss | ||
| chat-unread-indicator.scss | ||
| chat-upload-drop-zone.scss | ||
| chat-user-avatar.scss | ||
| core-extensions.scss | ||
| dc-filter-input.scss | ||
| direct-message-creator.scss | ||
| full-page-chat-header.scss | ||
| incoming-chat-webhooks.scss | ||
| index.scss | ||
| reviewable-chat-message.scss | ||
| sidebar-extensions.scss | ||