From 506491eed9c4670f060f58959dc75663da51bbe4 Mon Sep 17 00:00:00 2001 From: Kyle Geib Date: Tue, 11 Jan 2022 17:12:05 -0500 Subject: [PATCH] ISSUE-017 - Initial work on the Overlay Tool. Have basic state management in place and a number of simple prototypes in place to practice floating a div above the interface. --- src/App.tsx | 23 ++++-- src/components/Broadcast/BroadcastRoute.tsx | 4 +- .../OverlayControl/OverlayControl.tsx | 82 +++++++++++++++++++ .../OverlayDisplay/OverlayDisplay.tsx | 17 ++++ .../OverlayTool/OverlayDisplay/styles.ts | 20 +++++ src/components/OverlayTool/index.ts | 2 + .../Workspace/WorkspaceControls.tsx | 2 + src/components/Workspaces/WorkspacesRoute.tsx | 6 +- .../overlayTool/overlayToolSelector.ts | 3 + src/features/overlayTool/overlayToolSlice.ts | 79 ++++++++++++++++++ .../pageDimensions/pageDimensionsSelector.ts | 5 +- .../pageDimensions/pageDimensionsSlice.ts | 11 ++- src/store.ts | 2 + src/types/state.d.ts | 23 ++++++ 14 files changed, 265 insertions(+), 14 deletions(-) create mode 100644 src/components/OverlayTool/OverlayControl/OverlayControl.tsx create mode 100644 src/components/OverlayTool/OverlayDisplay/OverlayDisplay.tsx create mode 100644 src/components/OverlayTool/OverlayDisplay/styles.ts create mode 100644 src/components/OverlayTool/index.ts create mode 100644 src/features/overlayTool/overlayToolSelector.ts create mode 100644 src/features/overlayTool/overlayToolSlice.ts diff --git a/src/App.tsx b/src/App.tsx index 3b1e5de..839640c 100644 --- a/src/App.tsx +++ b/src/App.tsx @@ -1,7 +1,10 @@ import { Outlet } from "react-router-dom"; import { useDimensions } from "./utils/hooks"; -import { setMenuDimensions } from "./features/pageDimensions/pageDimensionsSlice"; +import { + setMenuDimensions, + setAppDimensions, +} from "./features/pageDimensions/pageDimensionsSlice"; import { MainMenu } from "./components/Menu"; import { useDispatch } from "react-redux"; @@ -9,16 +12,22 @@ import { useEffect } from "react"; function App() { const dispatch = useDispatch(); - const [ref, { height }] = useDimensions(); + const [appRef, { height: appHeight, width: appWidth }] = useDimensions(); + const [mainMenuRef, { height: mainMenuHeight }] = useDimensions(); + // Set App height and width. useEffect(() => { - // Make sure to not dispatch during a render. - dispatch(setMenuDimensions({ height })); - }, [height]); + dispatch(setAppDimensions({ height: appHeight, width: appWidth })); + }, [appHeight, appWidth]); + + // Set MainMenu height. + useEffect(() => { + dispatch(setMenuDimensions({ height: mainMenuHeight })); + }, [mainMenuHeight]); return ( -
- +
+
); diff --git a/src/components/Broadcast/BroadcastRoute.tsx b/src/components/Broadcast/BroadcastRoute.tsx index 1040288..cf1e7ba 100644 --- a/src/components/Broadcast/BroadcastRoute.tsx +++ b/src/components/Broadcast/BroadcastRoute.tsx @@ -2,10 +2,10 @@ import { useSelector } from "react-redux"; import { FullScreenContainer } from "../Common/FullScreenContainer.styled"; import { Layout } from "./Layout"; -import { menuSelector } from "../../features/pageDimensions/pageDimensionsSelector"; +import { menuDimensionsSelector } from "../../features/pageDimensions/pageDimensionsSelector"; export default function Broadcast() { - const { height } = useSelector(menuSelector); + const { height } = useSelector(menuDimensionsSelector); return ( diff --git a/src/components/OverlayTool/OverlayControl/OverlayControl.tsx b/src/components/OverlayTool/OverlayControl/OverlayControl.tsx new file mode 100644 index 0000000..5d6d684 --- /dev/null +++ b/src/components/OverlayTool/OverlayControl/OverlayControl.tsx @@ -0,0 +1,82 @@ +import { useState } from "react"; +import { useSelector, useDispatch } from "react-redux"; +import { PadBox } from "@bedrock-layout/padbox"; + +import { appDimensionsSelector } from "../../../features/pageDimensions/pageDimensionsSelector"; +import { overlayToolSelector } from "../../../features/overlayTool/overlayToolSelector"; +import { + initNewOverlayItem, + setCurrentOverlayId, + setPosition, + setVisibility, +} from "../../../features/overlayTool/overlayToolSlice"; + +import { Toggle } from "../../Common/Inputs/Toggle"; + + +export function OverlayControl() { + const dispatch = useDispatch(); + const { visible, currentOverlayItem } = useSelector(overlayToolSelector); + + + + + /* For prototyping use only */ + const { width: appWidth, height: appHeight } = useSelector(appDimensionsSelector); + const [overlayId, setOverlayId] = useState("foo_1.00000"); + const { width, height } = useSelector(appDimensionsSelector); + + const getRandomArbitrary = (min: number, max: number) => + Math.random() * (max - min) + min; + + const posRandomizer = () => { + dispatch(setPosition({ + x: Math.floor(getRandomArbitrary(50, width - 50)), + y: Math.floor(getRandomArbitrary(50, height - 50)), + })); + }; + const idRandomizer = () => { + const newId = `id_${getRandomArbitrary(1, 10)}`.slice(0, 10); + setOverlayId(newId); + dispatch(setCurrentOverlayId(newId)); + }; + /* For prototyping use only */ + + + + const onToggle = (value: boolean) => { + if (currentOverlayItem == null) { + dispatch(initNewOverlayItem({ + overlayId, + appDimensions: { height: appHeight, width: appWidth }, + })); + } + dispatch(setVisibility(value)); + }; + + return ( + + + + {/* For prototyping use only */} +
+ + Random Location + +
+ + Id: {overlayId} + + {/* For prototyping use only */} + +
+ ); +} diff --git a/src/components/OverlayTool/OverlayDisplay/OverlayDisplay.tsx b/src/components/OverlayTool/OverlayDisplay/OverlayDisplay.tsx new file mode 100644 index 0000000..2b0610d --- /dev/null +++ b/src/components/OverlayTool/OverlayDisplay/OverlayDisplay.tsx @@ -0,0 +1,17 @@ +import { useSelector } from "react-redux"; +import { overlayToolSelector } from "../../../features/overlayTool/overlayToolSelector"; + +import { OverlayItemContainer } from "./styles"; + +export function OverlayDisplay() { + const { currentOverlayItem } = useSelector(overlayToolSelector); + if (currentOverlayItem == null) return null; + const { id, position } = currentOverlayItem; + return ( + + {id} +
+ ({position.x}px {position.y}px) +
+ ); +} diff --git a/src/components/OverlayTool/OverlayDisplay/styles.ts b/src/components/OverlayTool/OverlayDisplay/styles.ts new file mode 100644 index 0000000..e843298 --- /dev/null +++ b/src/components/OverlayTool/OverlayDisplay/styles.ts @@ -0,0 +1,20 @@ +import styled from "styled-components"; +import { OverlayPosition } from "../../../types/state"; + +export type OverlayItemContainerProps = { + position: OverlayPosition, +}; +export const OverlayItemContainer = styled.div.attrs(({ + position: { x, y }, +}) => ({ + style: { + top: y, + left: x, + }, +}))` + position: absolute; + width: 150px; + height: 150px; + background-color: white; + box-shadow: 0px 7px 11px 1px black; +`; diff --git a/src/components/OverlayTool/index.ts b/src/components/OverlayTool/index.ts new file mode 100644 index 0000000..7f14705 --- /dev/null +++ b/src/components/OverlayTool/index.ts @@ -0,0 +1,2 @@ +export { OverlayDisplay } from "./OverlayDisplay/OverlayDisplay"; +export { OverlayControl } from "./OverlayControl/OverlayControl"; diff --git a/src/components/Workspaces/Workspace/WorkspaceControls.tsx b/src/components/Workspaces/Workspace/WorkspaceControls.tsx index a88c1f9..06ec061 100644 --- a/src/components/Workspaces/Workspace/WorkspaceControls.tsx +++ b/src/components/Workspaces/Workspace/WorkspaceControls.tsx @@ -6,6 +6,7 @@ import { setAnimatedBG } from "../../../features/workspace/workspaceSlice"; import { AnimatedBG } from "../../../types/state"; import { Toggle } from "../../Common/Inputs/Toggle"; +import { OverlayControl } from "../../OverlayTool"; export const WorkspaceControls = () => { const dispatch = useDispatch(); @@ -19,6 +20,7 @@ export const WorkspaceControls = () => { onToggle={(value: AnimatedBG) => { dispatch(setAnimatedBG(value)); }} /> + ); }; diff --git a/src/components/Workspaces/WorkspacesRoute.tsx b/src/components/Workspaces/WorkspacesRoute.tsx index 0a5de85..2d0c105 100644 --- a/src/components/Workspaces/WorkspacesRoute.tsx +++ b/src/components/Workspaces/WorkspacesRoute.tsx @@ -1,14 +1,15 @@ import { useSelector } from "react-redux"; import { Outlet } from "react-router-dom"; -import { menuSelector } from "../../features/pageDimensions/pageDimensionsSelector"; +import { menuDimensionsSelector } from "../../features/pageDimensions/pageDimensionsSelector"; import { FullScreenContainer } from "../Common/FullScreenContainer.styled"; import { WorkspaceList } from "./WorkspaceList"; import { LayoutGrid, LayoutGridItem } from "../Common/LayoutGrid.styled"; +import { OverlayDisplay } from "../OverlayTool"; export default function Workspaces() { - const { height } = useSelector(menuSelector); + const { height } = useSelector(menuDimensionsSelector); return ( @@ -18,6 +19,7 @@ export default function Workspaces() { + diff --git a/src/features/overlayTool/overlayToolSelector.ts b/src/features/overlayTool/overlayToolSelector.ts new file mode 100644 index 0000000..8c3523d --- /dev/null +++ b/src/features/overlayTool/overlayToolSelector.ts @@ -0,0 +1,3 @@ +import { RootState } from "../../types/state"; + +export const overlayToolSelector = (state: RootState) => state.overlayTool; diff --git a/src/features/overlayTool/overlayToolSlice.ts b/src/features/overlayTool/overlayToolSlice.ts new file mode 100644 index 0000000..dba96ad --- /dev/null +++ b/src/features/overlayTool/overlayToolSlice.ts @@ -0,0 +1,79 @@ +import { createSlice, PayloadAction } from "@reduxjs/toolkit"; + +import { + RootState, + OverlayPosition, + OverlayId, + AppDimensions, +} from "../../types/state"; + +const initialState: RootState["overlayTool"] = { + overlayIds: [], + currentOverlayId: null, + currentOverlayItem: null, + visible: false, +}; + +const makeNewOverlayItem = ( + overlayId: OverlayId, + appDimensions: AppDimensions, +) => ({ + id: overlayId, + position: { + x: appDimensions.width / 2, + y: appDimensions.height / 2, + }, + opacity: 1, + scale: 1, +}); + + +type InitNewOverlayItemAction = { + overlayId: OverlayId, + appDimensions: AppDimensions, +}; + +export const overlayToolSlice = createSlice({ + name: "overlayTool", + initialState, + reducers: { + initNewOverlayItem: (state, action: PayloadAction) => { + if (state.currentOverlayItem == null) { + state.currentOverlayItem = makeNewOverlayItem( + action.payload.overlayId, + action.payload.appDimensions, + ); + state.currentOverlayId = action.payload.overlayId; + } + }, + setVisibility: (state, action: PayloadAction) => { + state.visible = action.payload; + }, + setOverlayIds: (state, action: PayloadAction>) => { + state.overlayIds = action.payload; + }, + setCurrentOverlayId: (state, action: PayloadAction) => { + if ( + action.payload !== state.currentOverlayId && + state.currentOverlayItem != null + ) { + state.currentOverlayId = action.payload; + state.currentOverlayItem.id = action.payload; + } + }, + setPosition: (state, action: PayloadAction) => { + if (state.currentOverlayItem != null) { + state.currentOverlayItem.position = action.payload; + } + }, + }, +}); + +export const { + initNewOverlayItem, + setVisibility, + setOverlayIds, + setCurrentOverlayId, + setPosition, +} = overlayToolSlice.actions; +export default overlayToolSlice.reducer; diff --git a/src/features/pageDimensions/pageDimensionsSelector.ts b/src/features/pageDimensions/pageDimensionsSelector.ts index 413d347..f9db815 100644 --- a/src/features/pageDimensions/pageDimensionsSelector.ts +++ b/src/features/pageDimensions/pageDimensionsSelector.ts @@ -1,3 +1,6 @@ import { RootState } from "../../types/state"; -export const menuSelector = (state: RootState) => state.pageDimensions.menu; +export const menuDimensionsSelector = (state: RootState) => + state.pageDimensions.menu; +export const appDimensionsSelector = (state: RootState) => + state.pageDimensions.app; diff --git a/src/features/pageDimensions/pageDimensionsSlice.ts b/src/features/pageDimensions/pageDimensionsSlice.ts index fd1c5f2..9c2128a 100644 --- a/src/features/pageDimensions/pageDimensionsSlice.ts +++ b/src/features/pageDimensions/pageDimensionsSlice.ts @@ -1,11 +1,15 @@ import { createSlice, PayloadAction } from "@reduxjs/toolkit"; -import { RootState, MenuDimensions } from "../../types/state"; +import { RootState, MenuDimensions, AppDimensions } from "../../types/state"; const initialState: RootState["pageDimensions"] = { menu: { height: 0, }, + app: { + height: 0, + width: 0, + }, }; export const pageDimensionsSlice = createSlice({ @@ -15,8 +19,11 @@ export const pageDimensionsSlice = createSlice({ setMenuDimensions: (state, action: PayloadAction) => { state.menu = action.payload; }, + setAppDimensions: (state, action: PayloadAction) => { + state.app = action.payload; + }, }, }); -export const { setMenuDimensions } = pageDimensionsSlice.actions; +export const { setMenuDimensions, setAppDimensions } = pageDimensionsSlice.actions; export default pageDimensionsSlice.reducer; diff --git a/src/store.ts b/src/store.ts index ff421a5..5cc2731 100644 --- a/src/store.ts +++ b/src/store.ts @@ -2,10 +2,12 @@ import { configureStore, combineReducers } from "@reduxjs/toolkit"; import pageDimensions from "./features/pageDimensions/pageDimensionsSlice"; import workspace from "./features/workspace/workspaceSlice"; +import overlayTool from "./features/overlayTool/overlayToolSlice"; export const store = configureStore({ reducer: combineReducers({ pageDimensions, workspace, + overlayTool, }), }); diff --git a/src/types/state.d.ts b/src/types/state.d.ts index 07edffe..2591d87 100644 --- a/src/types/state.d.ts +++ b/src/types/state.d.ts @@ -1,16 +1,22 @@ export type RootState = { pageDimensions: PageDimensions, workspace: Workspace, + overlayTool: OverlayTool, }; // Page Dimensions export type PageDimensions = { menu: MenuDimensions, + app: AppDimensions, }; export type MenuDimensions = { height: number, }; +export type AppDimensions = { + height: number, + width: number, +}; // Workspace export type Workspace = { @@ -20,3 +26,20 @@ export type Workspace = { export type WorkspaceId = string; export type AnimatedBG = boolean; + +// Overlay Tool +export type OverlayTool = { + // workspaceId: WorkspaceId, + overlayIds: Array, + currentOverlayId: OverlayId | null, + currentOverlayItem: OverlayItem | null, + visible: boolean, +}; +export type OverlayId = string; +export type OverlayPosition = { x: number, y: number }; +export type OverlayItem = { + id: OverlayId, + position: OverlayPosition, + opacity: number, + scale: number, +};