8376dd2011
Similar to https://github.com/zed-industries/zed/pull/18690 & https://github.com/zed-industries/zed/pull/18695, this PR enables required docs for `ui` and does some cleanup. Changes: - Enables the `deny(missing_docs)` crate-wide. - Adds `allow(missing_docs)` on many modules until folks pick them up to document them - Documents some modules (all in `ui/src/styles`) - Crate root-level organization: Traits move to `traits`, other misc organization - Cleaned out a bunch of unused code. Note: I'd like to remove `utils/format_distance` but the assistant panel uses it. To move it over to use the `time_format` crate we may need to update it to use `time` instead of `chrono`. Needs more investigation. Release Notes: - N/A
88 lines
2.7 KiB
Rust
88 lines
2.7 KiB
Rust
#![allow(missing_docs)]
|
|
|
|
use crate::prelude::*;
|
|
use crate::v_flex;
|
|
use gpui::{
|
|
div, AnyElement, Element, IntoElement, ParentElement, RenderOnce, Styled, WindowContext,
|
|
};
|
|
use smallvec::SmallVec;
|
|
|
|
/// A popover is used to display a menu or show some options.
|
|
///
|
|
/// Clicking the element that launches the popover should not change the current view,
|
|
/// and the popover should be statically positioned relative to that element (not the
|
|
/// user's mouse.)
|
|
///
|
|
/// Example: A "new" menu with options like "new file", "new folder", etc,
|
|
/// Linear's "Display" menu, a profile menu that appears when you click your avatar.
|
|
///
|
|
/// Related elements:
|
|
///
|
|
/// [`ContextMenu`](crate::ContextMenu):
|
|
///
|
|
/// Used to display a popover menu that only contains a list of items. Context menus are always
|
|
/// launched by secondary clicking on an element. The menu is positioned relative to the user's cursor.
|
|
///
|
|
/// Example: Right clicking a file in the file tree to get a list of actions, right clicking
|
|
/// a tab to in the tab bar to get a list of actions.
|
|
///
|
|
/// `Dropdown`:
|
|
///
|
|
/// Used to display a list of options when the user clicks an element. The menu is
|
|
/// positioned relative the element that was clicked, and clicking an item in the
|
|
/// dropdown should change the value of the element that was clicked.
|
|
///
|
|
/// Example: A theme select control. Displays "One Dark", clicking it opens a list of themes.
|
|
/// When one is selected, the theme select control displays the selected theme.
|
|
#[derive(IntoElement)]
|
|
pub struct Popover {
|
|
children: SmallVec<[AnyElement; 2]>,
|
|
aside: Option<AnyElement>,
|
|
}
|
|
|
|
impl RenderOnce for Popover {
|
|
fn render(self, cx: &mut WindowContext) -> impl IntoElement {
|
|
div()
|
|
.flex()
|
|
.gap_1()
|
|
.child(v_flex().elevation_2(cx).py_1().children(self.children))
|
|
.when_some(self.aside, |this, aside| {
|
|
this.child(
|
|
v_flex()
|
|
.elevation_2(cx)
|
|
.bg(cx.theme().colors().surface_background)
|
|
.px_1()
|
|
.child(aside),
|
|
)
|
|
})
|
|
}
|
|
}
|
|
|
|
impl Default for Popover {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
impl Popover {
|
|
pub fn new() -> Self {
|
|
Self {
|
|
children: SmallVec::new(),
|
|
aside: None,
|
|
}
|
|
}
|
|
|
|
pub fn aside(mut self, aside: impl IntoElement) -> Self
|
|
where
|
|
Self: Sized,
|
|
{
|
|
self.aside = Some(aside.into_element().into_any());
|
|
self
|
|
}
|
|
}
|
|
|
|
impl ParentElement for Popover {
|
|
fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>) {
|
|
self.children.extend(elements)
|
|
}
|
|
}
|