From 297cef14ed4b8a7b1aa69ec0dc6868fd65e65256 Mon Sep 17 00:00:00 2001 From: Nate Butler Date: Mon, 23 Oct 2023 11:21:48 -0400 Subject: [PATCH] WIP add Elevation Docs --- crates/ui2/src/elevation.rs | 63 +++++++++++++++++++++++++++++++++++++ crates/ui2/src/lib.rs | 1 + 2 files changed, 64 insertions(+) create mode 100644 crates/ui2/src/elevation.rs diff --git a/crates/ui2/src/elevation.rs b/crates/ui2/src/elevation.rs new file mode 100644 index 0000000000000000000000000000000000000000..22045af0931b48555af0a27e04632faa4a2ff23d --- /dev/null +++ b/crates/ui2/src/elevation.rs @@ -0,0 +1,63 @@ +// TODO: Originally source from Material Design 3 +// TODO: Rewrite to be more Zed specific + +//! # Elevation +//! +//! Elevation in Zed applies to all surfaces and components. Elevation is categorized into levels. +//! +//! Elevation accomplishes the following: +//! - Allows surfaces to move in front of or behind others, such as content scrolling beneath app top bars. +//! - Reflects spatial relationships, for instance, how a floating action button’s shadow intimates its disconnection from a collection of cards. +//! - Directs attention to structures at the highest elevation, like a temporary dialog arising in front of other surfaces. +//! +//! Elevations are the initial elevation values assigned to components by default. +//! +//! Components may transition to a higher elevation in some cases, like user interations. +//! +//! On such occasions, components transition to predetermined dynamic elevation offsets. These are the typical elevations to which components move when they are not at rest. +//! +//! ## Understanding Elevation +//! +//! Elevation can be thought of as the physical closeness of an element to the user. Elements with lower elevations are physically further away from the user on the z-axis and appear to be underneath elements with higher elevations. +//! +//! Material Design 3 has a some great visualizations of elevation that may be helpful to understanding the mental modal of elevation. [Material Design – Elevation](https://m3.material.io/styles/elevation/overview) +//! +//! ## Elevation Level Overview +//! +//! Zed integrates six unique elevation levels in its design system. The elevation of a surface is expressed as a whole number ranging from 0 to 5, both numbers inclusive. A component’s elevation is ascertained by combining the component’s resting elevation with any dynamic elevation offsets. +//! +//! The levels are detailed as follows: +//! +//! 0. App Background (e.x.: Workspace, system window) +//! 1. UI Surface (e.x.: Title Bar, Panel, Tab Bar) +//! 2. Non-Modal Elevated Surfaces (e.x.: Floating Window) +//! 3. Elevated Elements (e.x.: Popover, Context Menu, Tooltip) +//! 4. Wash +//! 5. Modal Elevated Surfaces (e.x.: Palette, Modal, Notification) +//! 6. Dragged Element +//! +//! ## 0. App Background +//! +//! The app background constitutes the lowest elevation layer, appearing behind all other surfaces and components. It is predominantly used for the background color of the app. +//! +//! ## 1. UI Surface +//! +//! The UI Surface is the standard elevation for all elements and is placed above the app background. +//! +//! ## 2. Elevated Elements +//! +//! Elevated elements appear above the UI surface layer surfaces and components. Elevated elements are predominantly used for creating popovers, context menus, and tooltips. +//! +//! ## 3. Wash +//! +//! Wash denotes a distinct elevation reserved to isolate app UI layers from high elevation components such as modals, notifications, and overlaid panels. The wash may not consistently be visible when these components are active. This layer is often referred to as a scrim or overlay and the background color of the wash is typically deployed in its design. +//! +//! ## 4. Focused Element +//! +//! Focused elements obtain a higher elevation above surfaces and components at wash elevation. They are often used for modals, notifications, and overlaid panels and indicate that they are the sole element the user is interacting with at the moment. +//! +//! ## 5. Dragged Element +//! +//! Dragged elements gain the highest elevation, thus appearing above surfaces and components at the elevation of focused elements. These are typically used for elements that are being dragged, following the cursor + +pub enum Elevation {} diff --git a/crates/ui2/src/lib.rs b/crates/ui2/src/lib.rs index 841599c4b49d3071f326845b7805ee966d32a06b..48ca6f5d2f666651c0c9cf76325211b3add88960 100644 --- a/crates/ui2/src/lib.rs +++ b/crates/ui2/src/lib.rs @@ -24,6 +24,7 @@ mod color; mod components; mod element_ext; mod elements; +mod elevation; pub mod prelude; pub mod settings; mod static_data;