Skip to content

Commit

Permalink
feat: add getSpinner prop for custom loading spinner
Browse files Browse the repository at this point in the history 
Closes: #958
  • Loading branch information
@targos
targos committed Apr 4, 2021
1 parent f9ca9e1 commit 20a5137
Show file tree
Hide file tree
Showing 6 changed files with 140 additions and 114 deletions.
132 changes: 70 additions & 62 deletions src/component/NMRium.tsx
View file
Expand Up @@ -13,6 +13,7 @@ import {
memo,
Reducer,
CSSProperties,
ReactElement,
} from 'react';
import SplitPane from 'react-split-pane';
import { useToggle, useFullscreen } from 'react-use';
Expand All @@ -37,6 +38,7 @@ import { ModalProvider } from './elements/popup/Modal';
import Header from './header/Header';
import { HighlightProvider } from './highlight';
import DropZone from './loader/DropZone';
import { defaultGetSpinner, SpinnerProvider } from './loader/SpinnerContext';
import Panels from './panels/Panels';
import checkActionType from './reducer/IgnoreActions';
import {
Expand Down Expand Up @@ -139,6 +141,10 @@ export interface NMRiumProps {
docsBaseUrl?: string;
onDataChange?: (data: any) => void;
preferences?: NMRiumPreferences;
/**
* Returns a custom spinner that will be rendered while loading data.
*/
getSpinner?: () => ReactElement;
}

export type NMRiumPreferences = Partial<{
Expand Down Expand Up @@ -190,6 +196,7 @@ function NMRium({
onDataChange,
docsBaseUrl,
preferences,
getSpinner = defaultGetSpinner,
}: NMRiumProps) {
const rootRef = useRef<HTMLDivElement>(null);
const elementsWraperRef = useRef<HTMLDivElement>(null);
Expand Down Expand Up @@ -307,71 +314,72 @@ function NMRium({
<ModalProvider wrapperRef={elementsWraperRef.current}>
<HighlightProvider>
<AssignmentProvider spectraData={spectraData}>
<div
ref={rootRef}
css={containerStyles}
onContextMenu={preventContextMenuHandler}
>
<KeysListenerTracker />

<Header
isFullscreen={isFullscreen}
onMaximize={toggle}
/>

{/* ref={containerRef} */}
<SpinnerProvider value={getSpinner}>
<div
style={{
height: 'calc(100% - 36px)',
width: '100%',
backgroundColor: 'white',
}}
ref={rootRef}
css={containerStyles}
onContextMenu={preventContextMenuHandler}
>
<DropZone>
<ToolBar selectedTool={selectedTool} />
<SplitPane
style={splitPaneStyles.container}
resizerStyle={splitPaneStyles.resizer}
paneStyle={splitPaneStyles.pane}
pane1Style={
isRightPanelHide
? {
maxWidth: '100%',
width: 'calc(100% - 10px)',
}
: { maxWidth: '80%' }
}
split="vertical"
defaultSize={
isRightPanelHide
? '99%'
: 'calc(100% - 600px)'
}
minSize="80%"
onDragFinished={handleSplitPanelDragFinished}
onResizerDoubleClick={rightPanelHandler}
onDragStarted={() => {
setResizeEventStart(true);
}}
>
{displayerMode === DISPLAYER_MODE.DM_1D ? (
<Viewer1D />
) : (
<Viewer2D />
)}
{!isRightPanelHide ? (
<Panels
selectedTool={selectedTool}
displayerMode={displayerMode}
/>
) : (
<div />
)}
</SplitPane>
</DropZone>
<KeysListenerTracker />

<Header
isFullscreen={isFullscreen}
onMaximize={toggle}
/>

<div
style={{
height: 'calc(100% - 36px)',
width: '100%',
backgroundColor: 'white',
}}
>
<DropZone>
<ToolBar selectedTool={selectedTool} />
<SplitPane
style={splitPaneStyles.container}
resizerStyle={splitPaneStyles.resizer}
paneStyle={splitPaneStyles.pane}
pane1Style={
isRightPanelHide
? {
maxWidth: '100%',
width: 'calc(100% - 10px)',
}
: { maxWidth: '80%' }
}
split="vertical"
defaultSize={
isRightPanelHide
? '99%'
: 'calc(100% - 600px)'
}
minSize="80%"
onDragFinished={
handleSplitPanelDragFinished
}
onResizerDoubleClick={rightPanelHandler}
onDragStarted={() => {
setResizeEventStart(true);
}}
>
{displayerMode === DISPLAYER_MODE.DM_1D ? (
<Viewer1D />
) : (
<Viewer2D />
)}
{!isRightPanelHide ? (
<Panels
selectedTool={selectedTool}
displayerMode={displayerMode}
/>
) : null}
</SplitPane>
</DropZone>
</div>
<div ref={elementsWraperRef} id="main-wrapper" />
</div>
<div ref={elementsWraperRef} id="main-wrapper" />
</div>
</SpinnerProvider>
</AssignmentProvider>
</HighlightProvider>
</ModalProvider>
Expand Down
4 changes: 1 addition & 3 deletions src/component/elements/popup/Modal/Provider.js
View file
Expand Up @@ -211,9 +211,7 @@ function Provider({
</Transition>
</TransitionGroup>
</div>
) : (
<div />
)}
) : null}
</Fragment>,
root.current,
)}
Expand Down
50 changes: 50 additions & 0 deletions src/component/loader/DefaultSpinnerComponent.tsx
View file
@@ -0,0 +1,50 @@
/** @jsxImportSource @emotion/react */
import { css } from '@emotion/react';

const styles = css`
display: flex;
align-items: center;
justify-content: center;
background-color: rgba(255, 255, 255, 0.25);
height: 100%;
flex-direction: column;
user-select: none;
position: absolute;
width: 100%;
svg {
animation-duration: 0.5s;
animation-name: spinAnimation;
animation-iteration-count: infinite;
animation-fill-mode: forwards;
animation-direction: inherit;
animation-timing-function: linear;
animation-duration: 1s;
width: 100px;
height: 100px;
}
@keyframes spinAnimation {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}
`;

export default function DefaultSpinnerComponent() {
return (
<div css={styles}>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
<g fill="#61DAFB">
<path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z" />
<path d="M520.5 78.1z" />
</g>
</svg>
<p>Loading ...</p>
</div>
);
}
52 changes: 5 additions & 47 deletions src/component/loader/Spinner.jsx
View file
@@ -1,44 +1,10 @@
/** @jsxImportSource @emotion/react */
import { css } from '@emotion/react';
import { useState, Fragment, useEffect } from 'react';
import { useState, Fragment, useEffect, useContext } from 'react';

import { useChartData } from '../context/ChartContext';

import NoData from './NoData';
import { spinnerContext } from './SpinnerContext';

const styles = css`
display: flex;
align-items: center;
justify-content: center;
background-color: rgba(255, 255, 255, 0.25);
height: 100%;
flex-direction: column;
user-select: none;
position: absolute;
width: 100%;
svg {
animation-duration: 0.5s;
animation-name: spinAnimation;
animation-iteration-count: infinite;
animation-fill-mode: forwards;
animation-direction: inherit;
animation-timing-function: linear;
animation-duration: 1s;
width: 100px;
height: 100px;
}
@keyframes spinAnimation {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}
`;
function Spinner({ isLoading = true }) {
const { data } = useChartData();
const [checkEmpty, startCheckEmpty] = useState(false);
Expand All @@ -55,19 +21,11 @@ function Spinner({ isLoading = true }) {
};
}, [isLoading]);

const getSpinner = useContext(spinnerContext);

return (
<Fragment>
{isLoading && (
<div css={styles}>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
<g fill="#61DAFB">
<path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z" />
<path d="M520.5 78.1z" />
</g>
</svg>
<p>Loading ...</p>
</div>
)}
{isLoading && getSpinner()}
{checkEmpty && !isLoading && (
<NoData isEmpty={data && data.length === 0} />
)}
Expand Down
13 changes: 13 additions & 0 deletions src/component/loader/SpinnerContext.tsx
View file
@@ -0,0 +1,13 @@
import { createContext, ReactElement } from 'react';

import DefaultSpinnerComponent from './DefaultSpinnerComponent';

export function defaultGetSpinner() {
return <DefaultSpinnerComponent />;
}

export const spinnerContext = createContext<() => ReactElement>(
defaultGetSpinner,
);

export const SpinnerProvider = spinnerContext.Provider;
3 changes: 1 addition & 2 deletions src/component/toolbar/BasicToolBar.jsx
View file
Expand Up @@ -190,8 +190,7 @@ function BasicToolBar({ info, verticalAlign, displayerMode }) {
onClick={handleChangeDisplayViewMode}
>
<ToolTip title="Spectra alignment" popupPlacement="right">
<div />
{!isStacked ? <SvgNmrOverlay3Aligned /> : <SvgNmrOverlay3 />}{' '}
{!isStacked ? <SvgNmrOverlay3Aligned /> : <SvgNmrOverlay3 />}
</ToolTip>
</button>
)}
Expand Down

0 comments on commit 20a5137

Please sign in to comment.