Moved ContainerModel to Interfaces + replace all components to purecomponent (#12)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing

Reviewed-on: https://git.siklos-chaneru.duckdns.org/Siklos/svg-layout-designer-react/pulls/12
This commit is contained in:
Siklos 2022-08-05 10:36:40 -04:00
parent b5aa002877
commit e3228ccffa
13 changed files with 27 additions and 30 deletions

View file

@ -1,7 +1,7 @@
import * as React from 'react';
import { motion } from 'framer-motion';
import { Properties } from '../Properties/Properties';
import { IContainerModel, getDepth, MakeIterator } from '../SVG/Elements/ContainerModel';
import { IContainerModel, getDepth, MakeIterator } from '../../Interfaces/ContainerModel';
interface IElementsSidebarProps {
MainContainer: IContainerModel | null,
@ -13,7 +13,7 @@ interface IElementsSidebarProps {
selectContainer: (container: IContainerModel) => void
}
export class ElementsSidebar extends React.Component<IElementsSidebarProps> {
export class ElementsSidebar extends React.PureComponent<IElementsSidebarProps> {
public iterateChilds(handleContainer: (container: IContainerModel) => void): React.ReactNode {
if (!this.props.MainContainer) {
return null;
@ -53,7 +53,7 @@ export class ElementsSidebar extends React.Component<IElementsSidebarProps> {
duration: 0.150
}}
className={
`w-full elements-sidebar-row whitespace-pre
`w-full elements-sidebar-row whitespace-pre
text-left text-sm font-medium transition-all ${selectedClass}`
}
key={key}

View file

@ -0,0 +1,10 @@
import * as React from 'react';
interface IFloatingButtonProps {
}
const FloatingButton: React.FC<IFloatingButtonProps> = (props: IFloatingButtonProps) => {
return <></>;
};
export default FloatingButton;

View file

@ -9,7 +9,7 @@ interface IHistoryProps {
jumpTo: (move: number) => void
}
export class History extends React.Component<IHistoryProps> {
export class History extends React.PureComponent<IHistoryProps> {
public render() {
const isOpenClasses = this.props.isOpen ? 'right-0' : '-right-64';
@ -33,7 +33,7 @@ export class History extends React.Component<IHistoryProps> {
key={move}
onClick={() => this.props.jumpTo(move)}
className={
`w-full elements-sidebar-row whitespace-pre
`w-full elements-sidebar-row whitespace-pre
text-left text-sm font-medium transition-all ${selectedClass}`
}
>

View file

@ -6,20 +6,7 @@ interface IPropertiesProps {
onChange: (key: string, value: string) => void
}
interface IPropertiesState {
hasUpdate: boolean
}
export class Properties extends React.Component<IPropertiesProps, IPropertiesState> {
public state: IPropertiesState;
constructor(props: IPropertiesProps) {
super(props);
this.state = {
hasUpdate: false
};
}
export class Properties extends React.PureComponent<IPropertiesProps> {
public render() {
if (this.props.properties === undefined) {
return <div></div>;

View file

@ -1,5 +1,5 @@
import * as React from 'react';
import { getDepth, IContainerModel } from './ContainerModel';
import { getDepth, IContainerModel } from '../../../Interfaces/ContainerModel';
import { Dimension } from './Dimension';
export interface IContainerProps {
@ -8,7 +8,7 @@ export interface IContainerProps {
const GAP = 50;
export class Container extends React.Component<IContainerProps> {
export class Container extends React.PureComponent<IContainerProps> {
/**
* Render the container
* @returns Render the container

View file

@ -1,90 +0,0 @@
import Properties from '../../../Interfaces/Properties';
export interface IContainerModel {
children: IContainerModel[],
parent: IContainerModel | null,
properties: Properties,
userData: Record<string, string | number>
}
export class ContainerModel implements IContainerModel {
public children: IContainerModel[];
public parent: IContainerModel | null;
public properties: Properties;
public userData: Record<string, string | number>;
constructor(
parent: IContainerModel | null,
properties: Properties,
children: IContainerModel[] = [],
userData = {}) {
this.parent = parent;
this.properties = properties;
this.children = children;
this.userData = userData;
}
};
/**
* Returns a Generator iterating of over the children depth-first
*/
export function * MakeIterator(root: IContainerModel): Generator<IContainerModel, void, unknown> {
const queue: IContainerModel[] = [root];
const visited = new Set<IContainerModel>(queue);
while (queue.length > 0) {
const container = queue.pop() as IContainerModel;
yield container;
// if this reverse() gets costly, replace it by a simple for
container.children.forEach((child) => {
if (visited.has(child)) {
return;
}
visited.add(child);
queue.push(child);
});
}
}
/**
* Returns the depth of the container
* @returns The depth of the container
*/
export function getDepth(parent: IContainerModel) {
let depth = 0;
let current: IContainerModel | null = parent;
while (current != null) {
depth++;
current = current.parent;
}
return depth;
}
/**
* Returns the absolute position by iterating to the parent
* @returns The absolute position of the container
*/
export function getAbsolutePosition(container: IContainerModel): [number, number] {
let x = Number(container.properties.x);
let y = Number(container.properties.y);
let current = container.parent;
while (current != null) {
x += Number(current.properties.x);
y += Number(current.properties.y);
current = current.parent;
}
return [x, y];
}
export function findContainerById(root: IContainerModel, id: string): IContainerModel | undefined {
const it = MakeIterator(root);
for (const container of it) {
if (container.properties.id === id) {
return container;
}
}
return undefined;
}

View file

@ -9,7 +9,7 @@ interface IDimensionProps {
strokeWidth: number;
}
export class Dimension extends React.Component<IDimensionProps> {
export class Dimension extends React.PureComponent<IDimensionProps> {
public render() {
const style = {
stroke: 'black'

View file

@ -1,5 +1,5 @@
import * as React from 'react';
import { ContainerModel, getDepth, MakeIterator } from './ContainerModel';
import { ContainerModel, getDepth, MakeIterator } from '../../../Interfaces/ContainerModel';
import { Dimension } from './Dimension';
interface IDimensionLayerProps {

View file

@ -1,5 +1,5 @@
import * as React from 'react';
import { IContainerModel, getAbsolutePosition } from './ContainerModel';
import { IContainerModel, getAbsolutePosition } from '../../../Interfaces/ContainerModel';
interface ISelectorProps {
selected: IContainerModel | null

View file

@ -1,7 +1,7 @@
import * as React from 'react';
import { ReactSVGPanZoom, Tool, Value, TOOL_PAN } from 'react-svg-pan-zoom';
import { Container } from './Elements/Container';
import { ContainerModel } from './Elements/ContainerModel';
import { ContainerModel } from '../../Interfaces/ContainerModel';
import { Selector } from './Elements/Selector';
interface ISVGProps {
@ -16,7 +16,7 @@ interface ISVGState {
tool: Tool
}
export class SVG extends React.Component<ISVGProps> {
export class SVG extends React.PureComponent<ISVGProps> {
public state: ISVGState;
public svg: React.RefObject<SVGSVGElement>;

View file

@ -8,7 +8,7 @@ interface ISidebarProps {
buttonOnClick: (type: string) => void;
}
export default class Sidebar extends React.Component<ISidebarProps> {
export default class Sidebar extends React.PureComponent<ISidebarProps> {
public render() {
const listElements = this.props.componentOptions.map(componentOption =>
<button className='hover:bg-blue-600 transition-all sidebar-row' key={componentOption.Type} onClick={() => this.props.buttonOnClick(componentOption.Type)}>