mirrors/zed
1
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2025-01-12 13:24:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Use TS-flavored doc comments

Browse source
This commit is contained in:
Nate Butler 2023-06-15 11:10:37 -04:00 committed by Mikayla Maki
parent 31c1177737
commit 16564707df
No known key found for this signature in database
2 changed files with 64 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
styles/src/styleTree/interactive.ts
View file

@ -7,9 +7,17 @@ interface Interactive<T> {
disabled?: T,
}
// Helper function for creating Interactive<T> objects that works pretty much like Toggle<T>.
// It takes a object to be used as a value for `default` field and then fills out other fields
// with fields from either `base` or `modifications`. Notably, it does not touch `hover`, `clicked` and `disabled` if there are no modifications for it.
/**
* Helper function for creating Interactive<T> objects that works pretty much like Toggle<T>.
* It takes a object to be used as a value for `default` field and then fills out other fields
* with fields from either `base` or `modifications`.
* Notably, it does not touch `hover`, `clicked` and `disabled` if there are no modifications for it.
*
* @param defaultObj Object to be used as the value for `default` field.
* @param base Object containing base fields to be included in the resulting object.
* @param modifications Object containing modified fields to be included in the resulting object.
* @returns Interactive<T> object with fields from `base` and `modifications`.
*/
export function interactive<T extends Object>(base: T, modifications: DeepPartial<Interactive<T>>): Interactive<T> {
let interactiveObj: Interactive<T> = {
default: base,

52
styles/src/styleTree/toggle.ts
View file

@ -6,29 +6,35 @@ interface Toggleable<T> {
active: T,
}
/// Helper function for creating Toggleable objects; it takes a object of type T that is used as
/// `inactive` member of result Toggleable<T>. `active` member is created by applying `modifications` on top of `inactive` argument.
// Thus, the following call:
// ```
// toggleable({day: 1, month: "January"}, {day: 3})
// ```
// To return the following object:
// ```
// Toggleable<_>{
// inactive: { day: 1, month: "January" },
// active: { day: 3, month: "January" }
// }
// ```
// Remarkably, it also works for nested structures:
// ```
// toggleable({first_level: "foo", second_level: {nested_member: "nested"}}, {second_level: {nested_member: "another nested thing"}})
// ```
// ```
// Toggleable<_> {
// inactive: {first_level: "foo", second_level: {nested_member: "nested"}},
// active: { first_level: "foo", second_level: {nested_member: "another nested thing"}}
// }
// ```
/**
* Helper function for creating Toggleable objects.
* @template T The type of the object being toggled.
* @param inactive The initial state of the toggleable object.
* @param modifications The modifications to be applied to the initial state to create the active state.
* @returns A Toggleable object containing both the inactive and active states.
* @example
* ```
* toggleable({day: 1, month: "January"}, {day: 3})
* ```
* This returns the following object:
* ```
* Toggleable<_>{
* inactive: { day: 1, month: "January" },
* active: { day: 3, month: "January" }
* }
* ```
* The function also works for nested structures:
* ```
* toggleable({first_level: "foo", second_level: {nested_member: "nested"}}, {second_level: {nested_member: "another nested thing"}})
* ```
* Which returns:
* ```
* Toggleable<_> {
* inactive: {first_level: "foo", second_level: {nested_member: "nested"}},
* active: { first_level: "foo", second_level: {nested_member: "another nested thing"}}
* }
* ```
*/
export function toggleable<T extends Object>(inactive: T, modifications: DeepPartial<T>): Toggleable<T> {
let active: T = merge(inactive, modifications) as T;
return { active: active, inactive: inactive };