Nate Butler
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
106 lines
4.1 KiB
Rust
106 lines
4.1 KiB
Rust
use gpui::{px, rems, Pixels, Rems, WindowContext};
|
||
use settings::Settings;
|
||
use theme::{ThemeSettings, UiDensity};
|
||
|
||
use crate::{rems_from_px, BASE_REM_SIZE_IN_PX};
|
||
|
||
/// A dynamic spacing system that adjusts spacing based on
|
||
/// [UiDensity].
|
||
///
|
||
/// When possible, [Spacing] should be used over manual
|
||
/// or built-in spacing values in places dynamic spacing is needed.
|
||
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||
pub enum Spacing {
|
||
/// No spacing
|
||
None,
|
||
/// Usually a one pixel spacing. Grows to 2px in comfortable density.
|
||
/// @16px/rem: `1px`|`1px`|`2px`
|
||
XXSmall,
|
||
/// Extra small spacing - @16px/rem: `1px`|`2px`|`4px`
|
||
///
|
||
/// Relative to the user's `ui_font_size` and [UiDensity] setting.
|
||
XSmall,
|
||
/// Small spacing - @16px/rem: `2px`|`4px`|`6px`
|
||
///
|
||
/// Relative to the user's `ui_font_size` and [UiDensity] setting.
|
||
Small,
|
||
/// Medium spacing - @16px/rem: `3px`|`6px`|`8px`
|
||
///
|
||
/// Relative to the user's `ui_font_size` and [UiDensity] setting.
|
||
Medium,
|
||
/// Large spacing - @16px/rem: `4px`|`8px`|`10px`
|
||
///
|
||
/// Relative to the user's `ui_font_size` and [UiDensity] setting.
|
||
Large,
|
||
/// Extra Large spacing - @16px/rem: `8px`|`12px`|`16px`
|
||
///
|
||
/// Relative to the user's `ui_font_size` and [UiDensity] setting.
|
||
XLarge,
|
||
/// 2X Large spacing - @16px/rem: `12px`|`16px`|`20px`
|
||
///
|
||
/// Relative to the user's `ui_font_size` and [UiDensity] setting.
|
||
XXLarge,
|
||
}
|
||
|
||
impl Spacing {
|
||
/// Returns the spacing's scaling ratio in pixels.
|
||
pub fn spacing_ratio(self, cx: &WindowContext) -> f32 {
|
||
match ThemeSettings::get_global(cx).ui_density {
|
||
UiDensity::Compact => match self {
|
||
Spacing::None => 0.,
|
||
Spacing::XXSmall => 1. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XSmall => 1. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Small => 2. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Medium => 3. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Large => 4. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XLarge => 8. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XXLarge => 12. / BASE_REM_SIZE_IN_PX,
|
||
},
|
||
UiDensity::Default => match self {
|
||
Spacing::None => 0.,
|
||
Spacing::XXSmall => 1. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XSmall => 2. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Small => 4. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Medium => 6. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Large => 8. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XLarge => 12. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XXLarge => 16. / BASE_REM_SIZE_IN_PX,
|
||
},
|
||
UiDensity::Comfortable => match self {
|
||
Spacing::None => 0.,
|
||
Spacing::XXSmall => 2. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XSmall => 3. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Small => 6. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Medium => 8. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::Large => 10. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XLarge => 16. / BASE_REM_SIZE_IN_PX,
|
||
Spacing::XXLarge => 20. / BASE_REM_SIZE_IN_PX,
|
||
},
|
||
}
|
||
}
|
||
|
||
/// Returns the spacing's value in rems.
|
||
pub fn rems(self, cx: &WindowContext) -> Rems {
|
||
rems(self.spacing_ratio(cx))
|
||
}
|
||
|
||
/// Returns the spacing's value in pixels.
|
||
pub fn px(self, cx: &WindowContext) -> Pixels {
|
||
let ui_font_size_f32: f32 = ThemeSettings::get_global(cx).ui_font_size.into();
|
||
|
||
px(ui_font_size_f32 * self.spacing_ratio(cx))
|
||
}
|
||
}
|
||
|
||
fn user_spacing_style(cx: &WindowContext) -> UiDensity {
|
||
ThemeSettings::get_global(cx).ui_density
|
||
}
|
||
|
||
/// Returns a custom spacing value based on the current [`UiDensity`].
|
||
///
|
||
/// If you use this, talk to @iamnbutler and let me know what you're doing
|
||
/// that needs custom spacing– I'd love to understand so we can extend the system further and remove the need for this.
|
||
pub fn custom_spacing(cx: &WindowContext, size: f32) -> Rems {
|
||
rems_from_px(size * user_spacing_style(cx).spacing_ratio())
|
||
}
|