mirror of
https://github.com/discourse/discourse.git
synced 2024-12-02 08:15:49 +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>
159 lines
3.4 KiB
SCSS
159 lines
3.4 KiB
SCSS
.sidebar-section-wrapper {
|
|
.discourse-no-touch & {
|
|
&:hover {
|
|
.sidebar-section-header-wrapper {
|
|
.btn.dropdown-select-box-header,
|
|
.sidebar-section-header-button {
|
|
opacity: 1;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
.sidebar-section-header-wrapper {
|
|
display: flex;
|
|
|
|
.discourse-no-touch & {
|
|
&:hover {
|
|
background: var(--d-sidebar-highlight-background);
|
|
.d-icon-globe {
|
|
color: var(--d-sidebar-highlight-color);
|
|
}
|
|
}
|
|
}
|
|
|
|
&:focus-within {
|
|
background: var(--d-sidebar-highlight-background);
|
|
}
|
|
|
|
.sidebar-section-header-button {
|
|
font-size: var(--font-down-1);
|
|
}
|
|
|
|
.btn.dropdown-select-box-header,
|
|
.sidebar-section-header-button {
|
|
.discourse-no-touch & {
|
|
transition: all 0.25s;
|
|
opacity: 0;
|
|
|
|
&:focus {
|
|
opacity: 1;
|
|
}
|
|
}
|
|
|
|
background: transparent;
|
|
border: none;
|
|
margin-right: calc(var(--d-sidebar-row-horizontal-padding) / 3 * -1);
|
|
padding: calc(var(--d-sidebar-row-horizontal-padding) / 5)
|
|
calc(var(--d-sidebar-row-horizontal-padding) / 3);
|
|
|
|
.d-icon {
|
|
font-size: var(--font-down-1);
|
|
color: var(--d-sidebar-header-icon-color);
|
|
margin: 0;
|
|
}
|
|
|
|
&:focus {
|
|
outline: none;
|
|
background: var(--d-sidebar-highlight-hover-background);
|
|
.d-icon {
|
|
color: var(--d-sidebar-highlight-hover-icon);
|
|
}
|
|
}
|
|
|
|
.discourse-no-touch & {
|
|
&:hover {
|
|
background: var(--d-sidebar-highlight-hover-background);
|
|
.d-icon {
|
|
color: var(--d-sidebar-highlight-hover-icon);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
.sidebar-section-header {
|
|
flex: 1 1 auto;
|
|
color: var(--d-sidebar-header-color);
|
|
align-items: center;
|
|
min-width: 0;
|
|
padding: 0;
|
|
|
|
&.sidebar-section-header-collapsable {
|
|
justify-content: flex-start;
|
|
|
|
&:focus {
|
|
background: transparent;
|
|
}
|
|
}
|
|
}
|
|
|
|
.sidebar-section-header-text {
|
|
line-height: normal;
|
|
margin-right: 0.25em;
|
|
@include ellipsis;
|
|
}
|
|
|
|
.sidebar-section-header-global-indicator {
|
|
margin: 0 0.75em 0 0.25em;
|
|
font-size: var(--font-down-2);
|
|
.d-icon {
|
|
margin-top: -0.125em; // optical alignment
|
|
}
|
|
}
|
|
|
|
.sidebar-section-header-caret {
|
|
display: flex;
|
|
flex: 0 0 auto;
|
|
width: var(--d-sidebar-section-link-prefix-width);
|
|
height: var(--d-sidebar-section-link-prefix-width);
|
|
margin-right: var(--d-sidebar-section-link-prefix-margin-right);
|
|
align-items: center;
|
|
justify-content: center;
|
|
|
|
svg {
|
|
font-size: var(--font-down-1);
|
|
color: var(--d-sidebar-header-icon-color);
|
|
}
|
|
}
|
|
|
|
.select-kit-collection {
|
|
.texts {
|
|
font-size: var(--font-0);
|
|
text-transform: none;
|
|
line-height: var(--line-height-medium);
|
|
.name {
|
|
font-size: var(--font-0);
|
|
}
|
|
}
|
|
}
|
|
|
|
.sidebar-section-message-wrapper {
|
|
display: flex;
|
|
padding-top: 0;
|
|
height: initial;
|
|
}
|
|
|
|
.sidebar-section-message {
|
|
color: var(--primary);
|
|
padding-left: calc(
|
|
var(--d-sidebar-section-link-prefix-width) +
|
|
var(--d-sidebar-section-link-prefix-margin-right)
|
|
);
|
|
}
|
|
|
|
.sidebar-section-content {
|
|
padding-bottom: 0.875em;
|
|
margin: 0;
|
|
hr {
|
|
margin: 0em 1.5em;
|
|
}
|
|
}
|
|
}
|
|
|
|
.sidebar-section-header-global-indicator__content {
|
|
.d-icon-shield-alt {
|
|
padding-right: 0.25rem;
|
|
}
|
|
}
|