mirror of
https://github.com/discourse/discourse.git
synced 2024-11-24 12:42:57 +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>
|
||
|---|---|---|
| .. | ||
| admin | ||
| chat/composer | ||
| chat_message | ||
| list_channels | ||
| page_objects | ||
| reply_to_message | ||
| select_message | ||
| shortcuts | ||
| thread_list | ||
| thread_tracking | ||
| user_menu_notifications | ||
| user_status | ||
| anonymous_spec.rb | ||
| archive_channel_spec.rb | ||
| bookmark_message_spec.rb | ||
| browse_page_spec.rb | ||
| channel_about_page_spec.rb | ||
| channel_info_pages_spec.rb | ||
| channel_members_page_spec.rb | ||
| channel_message_upload_spec.rb | ||
| channel_settings_page_spec.rb | ||
| channel_thread_message_echoing_spec.rb | ||
| chat_channel_spec.rb | ||
| chat_composer_draft_spec.rb | ||
| chat_composer_spec.rb | ||
| chat_message_onebox_spec.rb | ||
| chat_summarization_spec.rb | ||
| closed_channel_spec.rb | ||
| create_channel_spec.rb | ||
| dates_separators_spec.rb | ||
| deleted_channel_spec.rb | ||
| deleted_message_spec.rb | ||
| document_title_spec.rb | ||
| drawer_spec.rb | ||
| edited_message_spec.rb | ||
| flag_message_spec.rb | ||
| hashtag_autocomplete_spec.rb | ||
| kick_user_from_channel_spec.rb | ||
| mention_warnings_spec.rb | ||
| message_errors_spec.rb | ||
| message_notifications_mobile_spec.rb | ||
| message_notifications_with_sidebar_spec.rb | ||
| message_thread_indicator_spec.rb | ||
| message_user_info.rb | ||
| move_message_to_channel_spec.rb | ||
| navigation_spec.rb | ||
| new_message_spec.rb | ||
| react_to_message_spec.rb | ||
| read_only_spec.rb | ||
| removing_channel_spec.rb | ||
| restore_message_spec.rb | ||
| reviewables_spec.rb | ||
| send_message_spec.rb | ||
| separate_sidebar_mode_spec.rb | ||
| sidebar_navigation_menu_spec.rb | ||
| sidebars_spec.rb | ||
| silenced_user_spec.rb | ||
| single_thread_spec.rb | ||
| thread_preview_spec.rb | ||
| transcript_spec.rb | ||
| unfollow_dm_channel_spec.rb | ||
| update_last_read.rb | ||
| uploads_spec.rb | ||
| user_card_spec.rb | ||
| user_chat_preferences_spec.rb | ||
| user_presence.rb | ||
| visit_channel_spec.rb | ||