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.
This commit is contained in:
Kyle Geib committed 2022-01-11 17:12:05 -05:00
1 parent 110d00d7bb
commit 506491eed9
14 files changed
+265 -14

No files matched your search

+16 -7
View File
@@ -1,7 +1,10 @@
import { Outlet } from "react-router-dom"; import { Outlet } from "react-router-dom";
import { useDimensions } from "./utils/hooks"; import { useDimensions } from "./utils/hooks";
import { setMenuDimensions } from "./features/pageDimensions/pageDimensionsSlice"; import {
setMenuDimensions,
setAppDimensions,
} from "./features/pageDimensions/pageDimensionsSlice";
import { MainMenu } from "./components/Menu"; import { MainMenu } from "./components/Menu";
import { useDispatch } from "react-redux"; import { useDispatch } from "react-redux";
@@ -9,16 +12,22 @@ import { useEffect } from "react";
function App() { function App() {
const dispatch = useDispatch(); const dispatch = useDispatch();
const [ref, { height }] = useDimensions<HTMLDivElement>(); const [appRef, { height: appHeight, width: appWidth }] = useDimensions<HTMLDivElement>();
const [mainMenuRef, { height: mainMenuHeight }] = useDimensions<HTMLDivElement>();
// Set App height and width.
useEffect(() => { useEffect(() => {
// Make sure to not dispatch during a render. dispatch(setAppDimensions({ height: appHeight, width: appWidth }));
dispatch(setMenuDimensions({ height })); }, [appHeight, appWidth]);
}, [height]);
// Set MainMenu height.
useEffect(() => {
dispatch(setMenuDimensions({ height: mainMenuHeight }));
}, [mainMenuHeight]);
return ( return (
<div className="App"> <div className="App" ref={appRef}>
<MainMenu ref={ref} /> <MainMenu ref={mainMenuRef} />
<Outlet /> <Outlet />
</div> </div>
); );
+2 -2
View File
@@ -2,10 +2,10 @@ import { useSelector } from "react-redux";
import { FullScreenContainer } from "../Common/FullScreenContainer.styled"; import { FullScreenContainer } from "../Common/FullScreenContainer.styled";
import { Layout } from "./Layout"; import { Layout } from "./Layout";
import { menuSelector } from "../../features/pageDimensions/pageDimensionsSelector"; import { menuDimensionsSelector } from "../../features/pageDimensions/pageDimensionsSelector";
export default function Broadcast() { export default function Broadcast() {
const { height } = useSelector(menuSelector); const { height } = useSelector(menuDimensionsSelector);
return ( return (
<FullScreenContainer minHeight={700} minWidth={900} heightCutoff={height}> <FullScreenContainer minHeight={700} minWidth={900} heightCutoff={height}>
@@ -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 (
<PadBox padding="sm">
<Toggle
label="Show Overlay"
toggled={visible}
onToggle={onToggle}
/>
{/* For prototyping use only */}
<br />
<a
onClick={posRandomizer}
>
Random Location
</a>
<br />
<a
onClick={idRandomizer}
>
Id: {overlayId}
</a>
{/* For prototyping use only */}
</PadBox>
);
}
@@ -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 (
<OverlayItemContainer position={position}>
{id}
<br />
({position.x}px {position.y}px)
</OverlayItemContainer>
);
}
@@ -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<OverlayItemContainerProps>(({
position: { x, y },
}) => ({
style: {
top: y,
left: x,
},
}))<OverlayItemContainerProps>`
position: absolute;
width: 150px;
height: 150px;
background-color: white;
box-shadow: 0px 7px 11px 1px black;
`;
+2
View File
@@ -0,0 +1,2 @@
export { OverlayDisplay } from "./OverlayDisplay/OverlayDisplay";
export { OverlayControl } from "./OverlayControl/OverlayControl";
@@ -6,6 +6,7 @@ import { setAnimatedBG } from "../../../features/workspace/workspaceSlice";
import { AnimatedBG } from "../../../types/state"; import { AnimatedBG } from "../../../types/state";
import { Toggle } from "../../Common/Inputs/Toggle"; import { Toggle } from "../../Common/Inputs/Toggle";
import { OverlayControl } from "../../OverlayTool";
export const WorkspaceControls = () => { export const WorkspaceControls = () => {
const dispatch = useDispatch(); const dispatch = useDispatch();
@@ -19,6 +20,7 @@ export const WorkspaceControls = () => {
onToggle={(value: AnimatedBG) => { onToggle={(value: AnimatedBG) => {
dispatch(setAnimatedBG(value)); dispatch(setAnimatedBG(value));
}} /> }} />
<OverlayControl />
</Grid> </Grid>
); );
}; };
@@ -1,14 +1,15 @@
import { useSelector } from "react-redux"; import { useSelector } from "react-redux";
import { Outlet } from "react-router-dom"; 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 { FullScreenContainer } from "../Common/FullScreenContainer.styled";
import { WorkspaceList } from "./WorkspaceList"; import { WorkspaceList } from "./WorkspaceList";
import { LayoutGrid, LayoutGridItem } from "../Common/LayoutGrid.styled"; import { LayoutGrid, LayoutGridItem } from "../Common/LayoutGrid.styled";
import { OverlayDisplay } from "../OverlayTool";
export default function Workspaces() { export default function Workspaces() {
const { height } = useSelector(menuSelector); const { height } = useSelector(menuDimensionsSelector);
return ( return (
<FullScreenContainer minHeight={700} minWidth={900} heightCutoff={height}> <FullScreenContainer minHeight={700} minWidth={900} heightCutoff={height}>
@@ -18,6 +19,7 @@ export default function Workspaces() {
</LayoutGridItem> </LayoutGridItem>
<LayoutGridItem column={2} row={1}> <LayoutGridItem column={2} row={1}>
<Outlet /> <Outlet />
<OverlayDisplay />
</LayoutGridItem> </LayoutGridItem>
</LayoutGrid> </LayoutGrid>
</FullScreenContainer> </FullScreenContainer>
@@ -0,0 +1,3 @@
import { RootState } from "../../types/state";
export const overlayToolSelector = (state: RootState) => state.overlayTool;
@@ -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<InitNewOverlayItemAction>) => {
if (state.currentOverlayItem == null) {
state.currentOverlayItem = makeNewOverlayItem(
action.payload.overlayId,
action.payload.appDimensions,
);
state.currentOverlayId = action.payload.overlayId;
}
},
setVisibility: (state, action: PayloadAction<boolean>) => {
state.visible = action.payload;
},
setOverlayIds: (state, action: PayloadAction<Array<OverlayId>>) => {
state.overlayIds = action.payload;
},
setCurrentOverlayId: (state, action: PayloadAction<OverlayId>) => {
if (
action.payload !== state.currentOverlayId &&
state.currentOverlayItem != null
) {
state.currentOverlayId = action.payload;
state.currentOverlayItem.id = action.payload;
}
},
setPosition: (state, action: PayloadAction<OverlayPosition>) => {
if (state.currentOverlayItem != null) {
state.currentOverlayItem.position = action.payload;
}
},
},
});
export const {
initNewOverlayItem,
setVisibility,
setOverlayIds,
setCurrentOverlayId,
setPosition,
} = overlayToolSlice.actions;
export default overlayToolSlice.reducer;
@@ -1,3 +1,6 @@
import { RootState } from "../../types/state"; 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;
@@ -1,11 +1,15 @@
import { createSlice, PayloadAction } from "@reduxjs/toolkit"; import { createSlice, PayloadAction } from "@reduxjs/toolkit";
import { RootState, MenuDimensions } from "../../types/state"; import { RootState, MenuDimensions, AppDimensions } from "../../types/state";
const initialState: RootState["pageDimensions"] = { const initialState: RootState["pageDimensions"] = {
menu: { menu: {
height: 0, height: 0,
}, },
app: {
height: 0,
width: 0,
},
}; };
export const pageDimensionsSlice = createSlice({ export const pageDimensionsSlice = createSlice({
@@ -15,8 +19,11 @@ export const pageDimensionsSlice = createSlice({
setMenuDimensions: (state, action: PayloadAction<MenuDimensions>) => { setMenuDimensions: (state, action: PayloadAction<MenuDimensions>) => {
state.menu = action.payload; state.menu = action.payload;
}, },
setAppDimensions: (state, action: PayloadAction<AppDimensions>) => {
state.app = action.payload;
},
}, },
}); });
export const { setMenuDimensions } = pageDimensionsSlice.actions; export const { setMenuDimensions, setAppDimensions } = pageDimensionsSlice.actions;
export default pageDimensionsSlice.reducer; export default pageDimensionsSlice.reducer;
+2
View File
@@ -2,10 +2,12 @@ import { configureStore, combineReducers } from "@reduxjs/toolkit";
import pageDimensions from "./features/pageDimensions/pageDimensionsSlice"; import pageDimensions from "./features/pageDimensions/pageDimensionsSlice";
import workspace from "./features/workspace/workspaceSlice"; import workspace from "./features/workspace/workspaceSlice";
import overlayTool from "./features/overlayTool/overlayToolSlice";
export const store = configureStore({ export const store = configureStore({
reducer: combineReducers({ reducer: combineReducers({
pageDimensions, pageDimensions,
workspace, workspace,
overlayTool,
}), }),
}); });
+23
View File
@@ -1,16 +1,22 @@
export type RootState = { export type RootState = {
pageDimensions: PageDimensions, pageDimensions: PageDimensions,
workspace: Workspace, workspace: Workspace,
overlayTool: OverlayTool,
}; };
// Page Dimensions // Page Dimensions
export type PageDimensions = { export type PageDimensions = {
menu: MenuDimensions, menu: MenuDimensions,
app: AppDimensions,
}; };
export type MenuDimensions = { export type MenuDimensions = {
height: number, height: number,
}; };
export type AppDimensions = {
height: number,
width: number,
};
// Workspace // Workspace
export type Workspace = { export type Workspace = {
@@ -20,3 +26,20 @@ export type Workspace = {
export type WorkspaceId = string; export type WorkspaceId = string;
export type AnimatedBG = boolean; export type AnimatedBG = boolean;
// Overlay Tool
export type OverlayTool = {
// workspaceId: WorkspaceId,
overlayIds: Array<OverlayId>,
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,
};