Merge branch 'master' into localSnippetEditor

client/components/dialog.jsx

@@ -6,10 +6,8 @@ function Dialog({ dismisskeys = [], closeText = 'Close', blocking = false, ...re
 	const dialogRef = useRef(null);
 
 	useEffect(()=>{
-		if(dismisskeys.length !== 0) {
-			blocking ? dialogRef.current?.showModal() : dialogRef.current?.show();
-		}
-	}, [dialogRef.current, dismisskeys]);
+		blocking ? dialogRef.current?.showModal() : dialogRef.current?.show();
+	}, []);
 
 	const dismiss = ()=>{
 		dismisskeys.forEach((key)=>{

client/homebrew/brewRenderer/brewRenderer.jsx

@@ -16,8 +16,11 @@ const Frame = require('react-frame-component').default;
 const dedent = require('dedent-tabs').default;
 const { printCurrentBrew } = require('../../../shared/helpers.js');
 
+import HeaderNav from './headerNav/headerNav.jsx';
+
 import { safeHTML } from './safeHTML.js';
 
+
 const PAGE_HEIGHT = 1056;
 
 const INITIAL_CONTENT = dedent`
@@ -50,8 +53,8 @@ const BrewPage = (props)=>{
 						props.onVisibilityChange(props.index + 1, true, false); // add page to array of visible pages.
 					else
 						props.onVisibilityChange(props.index + 1, false, false);
-				}
-			)},
+				});
+			},
 			{ threshold: .3, rootMargin: '0px 0px 0px 0px'  } // detect when >30% of page is within bounds.
 		);
 
@@ -61,8 +64,8 @@ const BrewPage = (props)=>{
 				entries.forEach((entry)=>{
 					if(entry.isIntersecting)
 						props.onVisibilityChange(props.index + 1, true, true); // Set this page as the center page
-				}
-			)},
+				});
+			},
 			{ threshold: 0, rootMargin: '-50% 0px -50% 0px' } // Detect when the page is at the center
 		);
 
@@ -115,7 +118,10 @@ const BrewRenderer = (props)=>{
 		pageShadows  : true
 	});
 
+	const [headerState, setHeaderState] = useState(false);
+
 	const mainRef  = useRef(null);
+	const pagesRef = useRef(null);
 
 	if(props.renderer == 'legacy') {
 		rawPages = props.text.split('\\page');
@@ -287,7 +293,7 @@ const BrewRenderer = (props)=>{
 				<NotificationPopup />
 			</div>
 
-			<ToolBar displayOptions={displayOptions} onDisplayOptionsChange={handleDisplayOptionsChange} visiblePages={state.visiblePages.length > 0 ? state.visiblePages : [state.centerPage]} totalPages={rawPages.length}/>
+			<ToolBar displayOptions={displayOptions} onDisplayOptionsChange={handleDisplayOptionsChange} visiblePages={state.visiblePages.length > 0 ? state.visiblePages : [state.centerPage]} totalPages={rawPages.length} headerState={headerState} setHeaderState={setHeaderState}/>
 
 			{/*render in iFrame so broken code doesn't crash the site.*/}
 			<Frame id='BrewRenderer' initialContent={INITIAL_CONTENT}
@@ -306,12 +312,13 @@ const BrewRenderer = (props)=>{
 						&&
 						<>
 							{renderedStyle}
-							<div className={`pages ${displayOptions.startOnRight ? 'recto' : 'verso'}	${displayOptions.spread}`} lang={`${props.lang || 'en'}`} style={pagesStyle}>
+							<div className={`pages ${displayOptions.startOnRight ? 'recto' : 'verso'}	${displayOptions.spread}`} lang={`${props.lang || 'en'}`} style={pagesStyle} ref={pagesRef}>
 								{renderedPages}
 							</div>
 						</>
 					}
 				</div>
+				{headerState ? <HeaderNav ref={pagesRef} /> : <></>}
 			</Frame>
 		</>
 	);

client/homebrew/brewRenderer/brewRenderer.less

@@ -70,6 +70,7 @@
 
 .pane { position : relative; }
 
+
 @media print {
 	.toolBar { display : none; }
 	.brewRenderer {
@@ -82,4 +83,7 @@
 			& > .page { box-shadow : unset; }
 		}
 	}
+	.headerNav {
+		visibility: hidden;
+	}
 }

client/homebrew/brewRenderer/errorBar/errorBar.jsx

@@ -1,75 +1,53 @@
 require('./errorBar.less');
 const React = require('react');
-const createClass = require('create-react-class');
-const _     = require('lodash');
 
-const ErrorBar = createClass({
-	displayName     : 'ErrorBar',
-	getDefaultProps : function() {
-		return {
-			errors : []
-		};
-	},
+import Dialog from '../../../components/dialog.jsx';
 
-	hasOpenError  : false,
-	hasCloseError : false,
-	hasMatchError : false,
+const DISMISS_BUTTON = <i className='fas fa-times dismiss' />;
 
-	renderErrors : function(){
-		this.hasOpenError = false;
-		this.hasCloseError = false;
-		this.hasMatchError = false;
+const ErrorBar = (props)=>{
+	if(!props.errors.length) return null;
+	let hasOpenError = false, hasCloseError = false, hasMatchError = false;
 
+	props.errors.map((err)=>{
+		if(err.id === 'OPEN')     hasOpenError  = true;
+		if(err.id === 'CLOSE')    hasCloseError = true;
+		if(err.id === 'MISMATCH') hasMatchError = true;
+	});
 
-		const errors = _.map(this.props.errors, (err, idx)=>{
-			if(err.id == 'OPEN') this.hasOpenError = true;
-			if(err.id == 'CLOSE') this.hasCloseError = true;
-			if(err.id == 'MISMATCH') this.hasMatchError = true;
-			return <li key={idx}>
-				Line {err.line} : {err.text}, '{err.type}' tag
-			</li>;
-		});
+	const renderErrors = ()=>(
+		<ul>
+			{props.errors.map((err, idx)=>{
+				return <li key={idx}>
+					Line {err.line} : {err.text}, '{err.type}' tag
+				</li>;
+			})}
+		</ul>
+	);
 
-		return <ul>{errors}</ul>;
-	},
-
-	renderProtip : function(){
-		const msg = [];
-		if(this.hasOpenError){
-			msg.push(<div>
-				An unmatched opening tag means there's an opened tag that isn't closed. You need to close your tags, like this {'</div>'}. Make sure to match types!
-			</div>);
-		}
-
-		if(this.hasCloseError){
-			msg.push(<div>
-				An unmatched closing tag means you closed a tag without opening it. Either remove it, or check to where you think you opened it.
-			</div>);
-		}
-
-		if(this.hasMatchError){
-			msg.push(<div>
-				A type mismatch means you closed a tag, but the last open tag was a different type.
-			</div>);
-		}
-		return <div className='protips'>
+	const renderProtip = ()=>(
+		<div className='protips'>
 			<h4>Protips!</h4>
-			{msg}
-		</div>;
-	},
+			{hasOpenError  && <div>Unmatched opening tag. Close your tags, like this {'</div>'}. Match types!</div>}
+			{hasCloseError && <div>Unmatched closing tag. Either remove it or check where it was opened.</div>}
+			{hasMatchError && <div>Type mismatch. Closed a tag with a different type.</div>}
+		</div>
+	);
 
-	render : function(){
-		if(!this.props.errors.length) return null;
-
-		return <div className='errorBar'>
-			<i className='fas fa-exclamation-triangle' />
-			<h3> There are HTML errors in your markup</h3>
-			<small>If these aren't fixed your brew will not render properly when you print it to PDF or share it</small>
-			{this.renderErrors()}
+	return (
+		<Dialog className='errorBar' closeText={DISMISS_BUTTON} >
+			<div>
+				<i className='fas fa-exclamation-triangle' />
+				<h2> There are HTML errors in your markup</h2>
+				<small>
+					If these aren't fixed your brew will not render properly when you print it to PDF or share it
+				</small>
+				{renderErrors()}
+			</div>
 			<hr />
-			{this.renderProtip()}
-		</div>;
-	}
-});
+			{renderProtip()}
+		</Dialog>
+	);
+};
 
 module.exports = ErrorBar;

client/homebrew/brewRenderer/errorBar/errorBar.less

@@ -1,60 +1,58 @@
 
-.errorBar{
+.errorBar {
 	position         : absolute;
-	z-index          : 10000;
-	box-sizing       : border-box;
+	top              : 32px;
+	z-index          : 1;
 	width            : 100%;
-	margin-right     : 13px;
-	padding          : 20px;
-	padding-bottom   : 10px;
-	padding-left     : 100px;
-	background-color : @red;
 	color            : white;
-	i{
-		position  : absolute;
-		left      : 30px;
-		opacity   : 0.8;
-		font-size : 3em;
-	}
-	h3{
-		font-size   : 1.1em;
-		font-weight : 800;
-	}
-	ul{
-		margin-top          : 15px;
-		font-size           : 0.8em;
-		list-style-position : inside;
-		list-style-type     : disc;
-		li{
-			line-height : 1.6em;
+	background-color : @red;
+	border           : unset;
+
+	div {
+		> i {
+			float         : left;
+			margin-right  : 10px;
+			margin-bottom : 20px;
+			font-size     : 3em;
+			opacity       : 0.8;
+		}
+		h2 { font-weight : 800; }
+		ul {
+			margin-top          : 15px;
+			font-size           : 0.8em;
+			list-style-position : inside;
+			list-style-type     : disc;
+			li { line-height : 1.6em; }
 		}
 	}
-	hr{
-		box-sizing       : border-box;
+	hr {
 		height           : 2px;
-		width            : 150%;
 		margin-top       : 25px;
 		margin-bottom    : 15px;
-		margin-left      : -100px;
 		background-color : darken(@red, 8%);
 		border           : none;
 	}
-	small{
-		font-size: 0.6em;
-		opacity: 0.7;
+	small {
+		font-size : 0.6em;
+		opacity   : 0.7;
 	}
-	.protips{
-		margin-left : -80px;
-		font-size   : 0.6em;
-		&>div{
-			margin-bottom : 10px;
-			line-height   : 1.2em;
-		}
-		h4{
-			opacity        : 0.8;
+	.protips {
+		font-size     : 0.6em;
+		line-height   : 1.2em;
+		h4 {
 			font-weight    : 800;
 			line-height    : 1.5em;
 			text-transform : uppercase;
 		}
 	}
+	button.dismiss {
+		position         : absolute;
+		top              : 20px;
+		right            : 30px;
+		padding          : unset;
+		font-size        : 40px;
+		background-color : transparent;
+		opacity          : 0.6;
+		&:hover { opacity : 1; }
+	}
 }

client/homebrew/brewRenderer/headerNav/headerNav.jsx

@@ -0,0 +1,106 @@
+require('./headerNav.less');
+
+import * as React from 'react';
+import * as _ from 'lodash';
+
+
+const MAX_TEXT_LENGTH = 40;
+
+const HeaderNav = React.forwardRef(({}, pagesRef)=>{
+
+	const renderHeaderLinks = ()=>{
+		if(!pagesRef.current) return;
+
+		const selector = [
+			'.pages > .page',									// All page elements, which by definition have IDs
+			'.page:not(:has(.toc)) > [id]',						// All direct children of non-ToC .page with an ID (Legacy)
+			'.page:not(:has(.toc)) > .columnWrapper > [id]',	// All direct children of non-ToC .page > .columnWrapper with an ID (V3)
+			'.page:not(:has(.toc)) h2',							// All non-ToC H2 titles, like Monster frame titles
+		];
+		const elements = pagesRef.current.querySelectorAll(selector.join(','));
+		if(!elements) return;
+		const navList = [];
+
+		// navList is a list of objects which have the following structure:
+		// {
+		// 		depth		: how deeply indented the item should be
+		// 		text		: the text to display in the nav link
+		// 		link		: the hyperlink to navigate to when clicked
+		// 		className	: [optional] the class to apply to the nav link for styling
+		// }
+
+		elements.forEach((el)=>{
+			if(el.className.match(/\bpage\b/)) {
+				let text = `Page ${el.id.slice(1)}`;	// The ID of a page *should* always be equal to `p` followed by the page number
+				if(el.querySelector('.toc')){			// If the page contains a table of contents, add "- Contents" to the display text
+					text += ' - Contents';
+				};
+				navList.push({
+					depth     : 0,						// Pages are always at the least indented level
+					text      : text,
+					link      : el.id,
+					className : 'pageLink'
+				});
+				return;
+			}
+			if(el.localName.match(/^h[1-6]/)){			// Header elements H1 through H6
+				navList.push({
+					depth : el.localName[1],			// Depth is set by the header level
+					text  : el.textContent,				// Use `textContent` because `innerText` is affected by rendering, e.g. 'content-visibility: auto'
+					link  : el.id
+				});
+				return;
+			}
+			navList.push({
+				depth : 7,								// All unmatched elements with IDs are set to the maximum depth (7)
+				text  : el.textContent,					// Use `textContent` because `innerText` is affected by rendering, e.g. 'content-visibility: auto'
+				link  : el.id
+			});
+		});
+
+		return _.map(navList, (navItem, index)=>{
+			return <HeaderNavItem {...navItem} key={index} />;
+		});
+
+	};
+
+	return <nav className='headerNav'>
+		<ul>
+			{renderHeaderLinks()}
+		</ul>
+	</nav>;
+}
+);
+
+const HeaderNavItem = ({ link, text, depth, className })=>{
+
+	const trimString = (text, prefixLength = 0)=>{
+		// Sanity check nav link strings
+		let output = text;
+
+		// If the string has a line break, only use the first line
+		if(text.indexOf('\n')){
+			output = text.split('\n')[0];
+		}
+
+		// Trim unecessary spaces from string
+		output = output.trim();
+
+		// Reduce excessively long strings
+		const maxLength = MAX_TEXT_LENGTH - prefixLength;
+		if(output.length > maxLength){
+			return `${output.slice(0, maxLength).trim()}...`;
+		}
+		return output;
+	};
+
+	if(!link || !text) return;
+
+	return <li>
+		<a href={`#${link}`} target='_self' className={`depth-${depth} ${className ?? ''}`}>
+			{trimString(text, depth)}
+		</a>
+	</li>;
+};
+
+export default HeaderNav;

client/homebrew/brewRenderer/headerNav/headerNav.less

@@ -0,0 +1,47 @@
+.headerNav {
+	position: fixed;
+	top: 32px;
+	left: 0px;
+	padding: 5px 10px;
+	background-color: #ccc;
+	border-radius: 5px;
+	max-height: calc(100vh - 32px);
+	max-width: 40vw;
+	overflow-y: auto;
+    &.active {
+        padding-bottom: 10px;
+        .navIcon {
+            padding-bottom: 10px;
+        }
+    }
+	.navIcon {
+		cursor: pointer;
+	}
+	li {
+		list-style-type: none;
+		a {
+			display: inline-block;
+			width: 100%;
+			font-family: 'Open Sans';
+			font-size: 12px;
+			padding: 2px;
+			color: inherit;
+			text-decoration: none;
+			cursor: pointer;
+			&:hover {
+				text-decoration: underline;
+			}
+			&.pageLink {
+				font-weight: 900;
+			}
+
+			@depths: 1,2,3,4,5,6,7;
+
+			each(@depths, {
+				&.depth-@{value} {
+					padding-left: ((@value - 1) * 0.5em);
+				}
+			});
+		}
+	}
+}

client/homebrew/brewRenderer/notificationPopup/notificationPopup.jsx

@@ -49,6 +49,7 @@ const NotificationPopup = ()=>{
 		));
 	};
 
+	if(!notifications.length) return;
 	return <Dialog className='notificationPopup' dismisskeys={dissmissKeyList} closeText={DISMISS_BUTTON} >
 		<div className='header'>
 			<i className='fas fa-info-circle info'></i>

client/homebrew/brewRenderer/toolBar/toolBar.jsx

@@ -9,7 +9,7 @@ import { Anchored, AnchoredBox, AnchoredTrigger } from '../../../components/Anch
 const MAX_ZOOM = 300;
 const MIN_ZOOM = 10;
 
-const ToolBar = ({ displayOptions, onDisplayOptionsChange, visiblePages, totalPages })=>{
+const ToolBar = ({ displayOptions, onDisplayOptionsChange, visiblePages, totalPages, headerState, setHeaderState })=>{
 
 	const [pageNum, setPageNum]     = useState(1);
 	const [toolsVisible, setToolsVisible] = useState(true);
@@ -62,7 +62,7 @@ const ToolBar = ({ displayOptions, onDisplayOptionsChange, visiblePages, totalPa
 			// find the page with the largest single dim (height or width) so that zoom can be adapted to fit it.
 			if(displayOptions.spread === 'facing')
 				minDimRatio = [...pages].reduce((minRatio, page)=>Math.min(minRatio, iframeWidth / page.offsetWidth / 2), Infinity);    // if 'facing' spread, fit two pages in view
-			else 
+			else
 				minDimRatio = [...pages].reduce((minRatio, page)=>Math.min(minRatio, iframeWidth / page.offsetWidth, iframeHeight / page.offsetHeight), Infinity);
 
 			desiredZoom = minDimRatio * 100;
@@ -76,7 +76,10 @@ const ToolBar = ({ displayOptions, onDisplayOptionsChange, visiblePages, totalPa
 
 	return (
 		<div id='preview-toolbar' className={`toolBar ${toolsVisible ? 'visible' : 'hidden'}`} role='toolbar'>
-			<button className='toggleButton' title={`${toolsVisible ? 'Hide' : 'Show'} Preview Toolbar`} onClick={()=>{setToolsVisible(!toolsVisible);}}><i className='fas fa-glasses' /></button>
+			<div className='toggleButton'>
+				<button title={`${toolsVisible ? 'Hide' : 'Show'} Preview Toolbar`} onClick={()=>{setToolsVisible(!toolsVisible);}}><i className='fas fa-glasses' /></button>
+				<button title={`${headerState ? 'Hide' : 'Show'} Header Navigation`} onClick={()=>{setHeaderState(!headerState);}}><i className='fas fa-rectangle-list' /></button>
+			</div>
 			{/*v=====----------------------< Zoom Controls >---------------------=====v*/}
 			<div className='group' role='group' aria-label='Zoom' aria-hidden={!toolsVisible}>
 				<button

client/homebrew/brewRenderer/toolBar/toolBar.less

@@ -166,7 +166,7 @@
 
 	&.hidden {
 		flex-wrap        : nowrap;
-		width            : 32px;
+		width            : 92px;
 		overflow         : hidden;
 		background-color : unset;
 		opacity          : 0.5;
@@ -178,10 +178,12 @@
 	}
 }
 
-button.toggleButton {
+.toggleButton {
 	position  : absolute;
 	left      : 0;
 	z-index   : 5;
 	width     : 32px;
 	min-width : unset;
+	height    : 100%;
+	display   : flex;
 }

client/homebrew/pages/editPage/editPage.jsx

@@ -444,42 +444,41 @@ const EditPage = createClass({
 			{this.renderNavbar()}
 
 			{this.props.brew.lock && <LockNotification shareId={this.props.brew.shareId} message={this.props.brew.lock.editMessage} />}
-			<div className="content">
-			<SplitPane onDragFinish={this.handleSplitMove}>
-				<Editor
-					ref={this.editor}
-					brew={this.state.brew}
-					onTextChange={this.handleTextChange}
-					onStyleChange={this.handleStyleChange}
-					onMetaChange={this.handleMetaChange}
-					onSnipChange={this.handleSnipChange}
-					reportError={this.errorReported}
-					renderer={this.state.brew.renderer}
-					userThemes={this.props.userThemes}
-					snippets={this.props.snippets}
-					themeBundle={this.state.themeBundle}
-					updateBrew={this.updateBrew}
-					onCursorPageChange={this.handleEditorCursorPageChange}
-					onViewPageChange={this.handleEditorViewPageChange}
-					currentEditorViewPageNum={this.state.currentEditorViewPageNum}
-					currentEditorCursorPageNum={this.state.currentEditorCursorPageNum}
-					currentBrewRendererPageNum={this.state.currentBrewRendererPageNum}
-				/>
-				<BrewRenderer
-					text={this.state.brew.text}
-					style={this.state.brew.style}
-					renderer={this.state.brew.renderer}
-					theme={this.state.brew.theme}
-					themeBundle={this.state.themeBundle}
-					errors={this.state.htmlErrors}
-					lang={this.state.brew.lang}
-					onPageChange={this.handleBrewRendererPageChange}
-					currentEditorViewPageNum={this.state.currentEditorViewPageNum}
-					currentEditorCursorPageNum={this.state.currentEditorCursorPageNum}
-					currentBrewRendererPageNum={this.state.currentBrewRendererPageNum}
-					allowPrint={true}
-				/>
-			</SplitPane>
+			<div className='content'>
+				<SplitPane onDragFinish={this.handleSplitMove}>
+					<Editor
+						ref={this.editor}
+						brew={this.state.brew}
+						onTextChange={this.handleTextChange}
+						onStyleChange={this.handleStyleChange}
+						onSnipChange={this.handleSnipChange}
+						onMetaChange={this.handleMetaChange}
+						reportError={this.errorReported}
+						renderer={this.state.brew.renderer}
+						userThemes={this.props.userThemes}
+						snippetBundle={this.state.themeBundle.snippets}
+						updateBrew={this.updateBrew}
+						onCursorPageChange={this.handleEditorCursorPageChange}
+						onViewPageChange={this.handleEditorViewPageChange}
+						currentEditorViewPageNum={this.state.currentEditorViewPageNum}
+						currentEditorCursorPageNum={this.state.currentEditorCursorPageNum}
+						currentBrewRendererPageNum={this.state.currentBrewRendererPageNum}
+					/>
+					<BrewRenderer
+						text={this.state.brew.text}
+						style={this.state.brew.style}
+						renderer={this.state.brew.renderer}
+						theme={this.state.brew.theme}
+						themeBundle={this.state.themeBundle}
+						errors={this.state.htmlErrors}
+						lang={this.state.brew.lang}
+						onPageChange={this.handleBrewRendererPageChange}
+						currentEditorViewPageNum={this.state.currentEditorViewPageNum}
+						currentEditorCursorPageNum={this.state.currentEditorCursorPageNum}
+						currentBrewRendererPageNum={this.state.currentBrewRendererPageNum}
+						allowPrint={true}
+					/>
+				</SplitPane>
 			</div>
 		</div>;
 	}

client/homebrew/pages/sharePage/sharePage.jsx

@@ -23,7 +23,9 @@ const SharePage = (props)=>{
 	});
 
 	const handleBrewRendererPageChange = useCallback((pageNumber)=>{
-		updateState({ currentBrewRendererPageNum: pageNumber });
+		setState((prevState)=>({
+			currentBrewRendererPageNum : pageNumber,
+			...prevState }));
 	}, []);
 
 	const handleControlKeys = (e)=>{