Files
UT-Registration-Plus/src/views/hooks/useSchedules.ts
Ethan Lanting c2328e461e feat(ui): color picker final touches (#491)
* fix: update CourseCellColorPicker.tsx background to white

* feat: add color picker to CalendarCourseCell component

* feat: add color picker functionality to update course colors

* fix: type issues with storybook components

* feat: add useColorPicker hook, isValidHexColor and updateCourseColors utilities

* refactor: color picker logic and UI components

* refactor: update useFlattenedCourseSchedule hook to include courseID property

* refactor: update storybook calendar components with updated props

* refactor: update color picker ui logic to account for position of cell

* fix: revert back to error handling for invalid rgb

* refactor: update jsdocs

* refactor: integrate ColorPickerContext into Calendar components and update props

* refactor: integrate ColorPickerContext into Calendar components and update related props

* refactor: change JSDocs comments and remove unused color inversion state

* refactor: update story components

* feat: add functionality for selecting secondary course colors

* refactor: enhance HexColorEditor to dynamically adjust tag icon color based on preview color

* refactor: simplify JSDoc comment in useColorPicker hook

* fix: revert Button component

* refactor: update CalendarCourseCell component positioning and styling

* fix: correct types in color.ts

* feat: add getDarkerShade function to compute darker shades of hex colors

* feat: add shadow to color picker button

* fix: update button size in ColorPatch component

* feat: implement debounced input for hex color editor and add useDebounce hook

* chore: utilize the logical and && operator instead of the ternary operator

* fix: imports and palette icon

* refactor: remove unused import

* fix: bug when course add fails with custom colors

* chore: run lint

* chore: run check-types

* feat: add HSL color type and conversion functions

* refactor: rename colorway to theme

* fix: hide color picker on screenshot

* fix: undo important syntax

* refactor: rename SomeFunction to DebouncedCallback

* refactor: remove inner function

* refactor: update return type to DebouncedCallback

* fix: adjust sizes for hash and palette button

* feat: create tests for hexToHSL and isValidHexColor

* refactor: update parameter type to use HexColor

* fix: increase size of palette button

* fix: update dependency array for hex code debounce

* fix: change colorPickerRef element ref

* feat: add Roboto Mono font

* fix: update input class to use monospace font

* feat: add getLighterShade function

* chore: run prettier and lint

* feat: synchronize local hex code with hexCode prop changes

---------

Co-authored-by: doprz <52579214+doprz@users.noreply.github.com>
2025-01-29 20:32:06 -06:00

167 lines
5.8 KiB
TypeScript

import { UserScheduleStore } from '@shared/storage/UserScheduleStore';
import type { HexColor } from '@shared/types/Color';
import { UserSchedule } from '@shared/types/UserSchedule';
import { getColorwayFromColor, getCourseColors, getDarkerShade, getLighterShade } from '@shared/util/colors';
import { useEffect, useState } from 'react';
let schedulesCache: UserSchedule[] = [];
let activeIndexCache = -1;
let initialLoad = true;
const errorSchedule = new UserSchedule({
courses: [],
id: 'error',
name: 'No Schedule Selected',
hours: 0,
updatedAt: Date.now(),
});
/**
* Fetches the user schedules from storage and sets the cached state.
*/
async function fetchData() {
const [storedSchedules, storedActiveIndex] = await Promise.all([
UserScheduleStore.get('schedules'),
UserScheduleStore.get('activeIndex'),
]);
schedulesCache = storedSchedules.map(s => new UserSchedule(s));
activeIndexCache = storedActiveIndex >= 0 ? storedActiveIndex : 0;
}
/**
* Custom hook that manages user schedules.
* @returns A tuple containing the active schedule and an array of all schedules.
*/
export default function useSchedules(): [active: UserSchedule, schedules: UserSchedule[]] {
const [schedules, setSchedules] = useState<UserSchedule[]>(schedulesCache);
const [activeIndex, setActiveIndex] = useState<number>(activeIndexCache);
const [activeSchedule, setActiveSchedule] = useState<UserSchedule>(schedules[activeIndex] ?? errorSchedule);
if (initialLoad) {
initialLoad = false;
// trigger suspense
// eslint-disable-next-line @typescript-eslint/no-throw-literal
throw new Promise(res => {
fetchData().then(res);
});
}
useEffect(() => {
const l1 = UserScheduleStore.listen('schedules', ({ newValue }) => {
schedulesCache = newValue.map(s => new UserSchedule(s));
setSchedules(schedulesCache);
});
const l2 = UserScheduleStore.listen('activeIndex', ({ newValue }) => {
activeIndexCache = newValue;
setActiveIndex(newValue);
});
return () => {
UserScheduleStore.removeListener(l1);
UserScheduleStore.removeListener(l2);
};
}, []);
// recompute active schedule on a schedule/index change
useEffect(() => {
setActiveSchedule(schedules[activeIndex] ?? errorSchedule);
}, [activeIndex, schedules]);
return [activeSchedule, schedules];
}
/**
* Returns the active schedule.
* @returns The active schedule.
*/
export function getActiveSchedule(): UserSchedule {
return schedulesCache[activeIndexCache] ?? errorSchedule;
}
/**
* Replaces the old schedule with the new schedule.
* @param oldSchedule - The old schedule to be replaced.
* @param newSchedule - The new schedule to replace the old schedule.
*/
export async function replaceSchedule(oldSchedule: UserSchedule, newSchedule: UserSchedule) {
const schedules = await UserScheduleStore.get('schedules');
let oldIndex = schedules.findIndex(s => s.id === oldSchedule.id);
oldIndex = oldIndex !== -1 ? oldIndex : 0;
schedules[oldIndex] = newSchedule;
await UserScheduleStore.set('schedules', schedules);
}
/**
* Switches the active schedule to the one with the specified id.
* @param id - The id of the schedule to switch to.
* @returns A promise that resolves when the active schedule has been switched.
*/
export async function switchSchedule(id: string): Promise<void> {
console.log('Switching schedule...');
const schedules = await UserScheduleStore.get('schedules');
const activeIndex = schedules.findIndex(s => s.id === id);
await UserScheduleStore.set('activeIndex', activeIndex);
}
/**
* Switches the active schedule to the one with the specified name.
* @param name - The name of the schedule to switch to.
* @returns A promise that resolves when the active schedule has been switched.
*/
export async function switchScheduleByName(name: string): Promise<void> {
console.log('Switching schedule...');
const schedules = await UserScheduleStore.get('schedules');
const activeIndex = schedules.findIndex(s => s.name === name);
await UserScheduleStore.set('activeIndex', activeIndex);
}
/**
* Updates the color of a course in the active schedule.
*
* @param courseID - The ID of the course to update.
* @param color - The new color to set for the course.
* @throws If the course with the given ID is not found.
*/
export async function updateCourseColors(courseID: number, primaryColor: HexColor) {
const activeSchedule = getActiveSchedule();
const updatedCourseIndex = activeSchedule.courses.findIndex(c => c.uniqueId === courseID);
if (updatedCourseIndex === -1) {
throw new Error(`Course with ID ${courseID} not found`);
}
const newSchedule = new UserSchedule(activeSchedule);
const updatedCourse = newSchedule.courses[updatedCourseIndex];
if (!updatedCourse) {
throw new Error(`Course with ID ${courseID} not found`);
}
let secondaryColor: HexColor;
try {
const { colorway: primaryColorWay, index: primaryIndex } = getColorwayFromColor(primaryColor);
const { secondaryColor: colorFromWay } = getCourseColors(primaryColorWay, primaryIndex, 400);
if (!colorFromWay) {
throw new Error('Secondary color not found');
}
secondaryColor = colorFromWay;
} catch (e) {
secondaryColor = getDarkerShade(primaryColor, 20);
// if primaryColor is too dark, get lighter shade instead
if (secondaryColor === '#000000') {
secondaryColor = getLighterShade(primaryColor, 35);
}
}
updatedCourse.colors.primaryColor = primaryColor;
updatedCourse.colors.secondaryColor = secondaryColor;
newSchedule.courses[updatedCourseIndex] = updatedCourse;
await replaceSchedule(activeSchedule, newSchedule);
}