Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add resize to document field #7729

Merged
merged 6 commits into from
Jul 26, 2022
Merged

Add resize to document field #7729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
13c4b39
Add resize to document field
Achisingh Jul 20, 2022
1268914
UI fixes
Achisingh Jul 21, 2022
6e4b2b7
linting fix
Achisingh Jul 21, 2022
f1f0a51
Editor read only fix
Achisingh Jul 22, 2022
081f5b8
lint fix
Achisingh Jul 25, 2022
5019c53
update changeset to a change
dcousens Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tame-meals-guess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@keystone-6/fields-document': minor
---

Changes the editors default overflow behaviour to align with other multi-line text inputs, supporting scrolling instead of an unbounded height for the field.
34 changes: 13 additions & 21 deletions docs/components/docs/DocumentEditorDemo.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
/** @jsx jsx */
import { getInitialPropsValue } from '@keystone-6/fields-document/src/DocumentEditor/component-blocks/initial-values';
import React, { ReactNode, useContext, useEffect, useMemo, useState } from 'react';
import { Toolbar } from '@keystone-6/fields-document/src/DocumentEditor/Toolbar';
import { DocumentFeatures } from '@keystone-6/fields-document/views';
import {
createDocumentEditor,
DocumentEditorEditable,
DocumentEditorProvider,
DocumentEditor,
Editor,
} from '@keystone-6/fields-document/src/DocumentEditor';
import {
Expand Down Expand Up @@ -276,19 +274,21 @@ export function DocumentFeaturesFormAndCode() {

export const DocumentEditorDemo = () => {
const [value, setValue] = useState(initialContent as any);
const [key, setKey] = useState(0);
const { documentFeatures, formValue } = useContext(DocumentFeaturesContext);

const editor = useMemo(
() => createDocumentEditor(documentFeatures, componentBlocks, emptyObj),
[documentFeatures]
);

// this is why we're creating the editor ourselves and not using the DocumentEditor component
useEffect(() => {
// we want to force normalize when the document features change so
// that no invalid things exist after a user changes something
const editor = createDocumentEditor(documentFeatures, componentBlocks, emptyObj);
editor.children = value;
Editor.normalize(editor, { force: true });
}, [editor, documentFeatures]);
setValue(editor.children);
// slate looks like it's a controlled component but it actually isn't
// so we need to re-mount it so that it looks at the updated value
setKey(x => x + 1);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [documentFeatures]);

return (
<div
Expand Down Expand Up @@ -330,22 +330,14 @@ export const DocumentEditorDemo = () => {
borderBottom: `1px var(--border) solid`,
}}
>
<DocumentEditorProvider
<DocumentEditor
key={key}
value={value}
onChange={setValue}
editor={editor}
componentBlocks={componentBlocks}
documentFeatures={documentFeatures}
relationships={emptyObj}
>
{useMemo(
() => (
<Toolbar documentFeatures={documentFeatures} />
),
[documentFeatures]
)}
<DocumentEditorEditable />
</DocumentEditorProvider>
/>
</div>
<details css={{ marginBottom: 'var(--space-xlarge)' }}>
<summary>View the Field Config</summary>
Expand Down
166 changes: 87 additions & 79 deletions packages/fields-document/src/DocumentEditor/Toolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,87 +55,83 @@ export function Toolbar({
const relationship = useContext(DocumentFieldRelationshipsContext);
const blockComponent = useContext(ComponentBlockContext);
const hasBlockItems = Object.entries(relationship).length || Object.keys(blockComponent).length;

const hasMarks = Object.values(documentFeatures.formatting.inlineMarks).some(x => x);
return (
<ToolbarContainer>
{!!documentFeatures.formatting.headingLevels.length && (
<Fragment>
<ToolbarGroup>
{!!documentFeatures.formatting.headingLevels.length && (
<HeadingMenu headingLevels={documentFeatures.formatting.headingLevels} />
<ToolbarSeparator />
</Fragment>
)}
{Object.values(documentFeatures.formatting.inlineMarks).some(x => x) && (
<Fragment>
<InlineMarks marks={documentFeatures.formatting.inlineMarks} />
<ToolbarSeparator />
</Fragment>
)}
{(documentFeatures.formatting.alignment.center ||
documentFeatures.formatting.alignment.end) && (
<TextAlignMenu alignment={documentFeatures.formatting.alignment} />
)}
{documentFeatures.formatting.listTypes.unordered && (
<Tooltip
content={
<Fragment>
Bullet List <KeyboardInTooltip>- </KeyboardInTooltip>
</Fragment>
}
weight="subtle"
>
{attrs => (
<ListButton type="unordered-list" {...attrs}>
<BulletListIcon />
</ListButton>
)}
</Tooltip>
)}
{documentFeatures.formatting.listTypes.ordered && (
<Tooltip
content={
<Fragment>
Numbered List <KeyboardInTooltip>1. </KeyboardInTooltip>
</Fragment>
}
weight="subtle"
>
{attrs => (
<ListButton type="ordered-list" {...attrs}>
<NumberedListIcon />
</ListButton>
)}
</Tooltip>
)}
{(documentFeatures.formatting.alignment.center ||
documentFeatures.formatting.alignment.end ||
documentFeatures.formatting.listTypes.unordered ||
documentFeatures.formatting.listTypes.ordered) && <ToolbarSeparator />}

{documentFeatures.dividers && dividerButton}
{documentFeatures.links && linkButton}
{documentFeatures.formatting.blockTypes.blockquote && blockquoteButton}
{!!documentFeatures.layouts.length && <LayoutsButton layouts={documentFeatures.layouts} />}
{documentFeatures.formatting.blockTypes.code && codeButton}
{!!hasBlockItems && <InsertBlockMenu />}
)}
{hasMarks && <InlineMarks marks={documentFeatures.formatting.inlineMarks} />}
{hasMarks && <ToolbarSeparator />}
{(documentFeatures.formatting.alignment.center ||
documentFeatures.formatting.alignment.end) && (
<TextAlignMenu alignment={documentFeatures.formatting.alignment} />
)}
{documentFeatures.formatting.listTypes.unordered && (
<Tooltip
content={
<Fragment>
Bullet List <KeyboardInTooltip>- </KeyboardInTooltip>
</Fragment>
}
weight="subtle"
>
{attrs => (
<ListButton type="unordered-list" {...attrs}>
<BulletListIcon />
</ListButton>
)}
</Tooltip>
)}
{documentFeatures.formatting.listTypes.ordered && (
<Tooltip
content={
<Fragment>
Numbered List <KeyboardInTooltip>1. </KeyboardInTooltip>
</Fragment>
}
weight="subtle"
>
{attrs => (
<ListButton type="ordered-list" {...attrs}>
<NumberedListIcon />
</ListButton>
)}
</Tooltip>
)}
{(documentFeatures.formatting.alignment.center ||
documentFeatures.formatting.alignment.end ||
documentFeatures.formatting.listTypes.unordered ||
documentFeatures.formatting.listTypes.ordered) && <ToolbarSeparator />}

<ToolbarSeparator />
{documentFeatures.dividers && dividerButton}
{documentFeatures.links && linkButton}
{documentFeatures.formatting.blockTypes.blockquote && blockquoteButton}
{!!documentFeatures.layouts.length && <LayoutsButton layouts={documentFeatures.layouts} />}
{documentFeatures.formatting.blockTypes.code && codeButton}
{!!hasBlockItems && <InsertBlockMenu />}
</ToolbarGroup>
{useMemo(() => {
const ExpandIcon = viewState?.expanded ? Minimize2Icon : Maximize2Icon;
return (
viewState && (
<Tooltip content={viewState.expanded ? 'Collapse' : 'Expand'} weight="subtle">
{attrs => (
<ToolbarButton
onMouseDown={event => {
event.preventDefault();
viewState.toggle();
}}
{...attrs}
>
<ExpandIcon size="small" />
</ToolbarButton>
)}
</Tooltip>
<ToolbarGroup>
<ToolbarSeparator />
<Tooltip content={viewState.expanded ? 'Collapse' : 'Expand'} weight="subtle">
{attrs => (
<ToolbarButton
onMouseDown={event => {
event.preventDefault();
viewState.toggle();
}}
{...attrs}
>
<ExpandIcon size="small" />
</ToolbarButton>
)}
</Tooltip>
</ToolbarGroup>
)
);
}, [viewState])}
Expand Down Expand Up @@ -182,16 +178,28 @@ const ToolbarContainer = ({ children }: { children: ReactNode }) => {
return (
<div
css={{
backgroundColor: colors.background,
boxShadow: `0 1px ${colors.border}, 0 -1px ${colors.border}`,
paddingBottom: spacing.small,
paddingTop: spacing.small,
borderBottom: `1px solid ${colors.border}`,
background: colors.background,
position: 'sticky',
top: 0,
zIndex: 2,
borderTopLeftRadius: 'inherit',
borderTopRightRadius: 'inherit',
}}
>
<ToolbarGroup>{children}</ToolbarGroup>
<div
css={{
display: 'flex',
flexDirection: 'row',
justifyContent: 'space-between',
alignItems: 'center',
height: 40,
paddingLeft: spacing.xsmall,
paddingRight: spacing.xsmall,
}}
>
{children}
</div>
</div>
);
};
Expand Down Expand Up @@ -487,7 +495,7 @@ function MoreFormattingDialog({
return (
<InlineDialog
onMouseDown={event => {
if ((event.target as any).nodeName === 'BUTTON') {
if (event.target instanceof HTMLElement && event.target.closest('button')) {
onCloseMenu();
}
}}
Expand Down
43 changes: 34 additions & 9 deletions packages/fields-document/src/DocumentEditor/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ export function DocumentEditor({
relationships: Relationships;
documentFeatures: DocumentFeatures;
} & Omit<EditableProps, 'value' | 'onChange'>) {
const { colors, spacing } = useTheme();
const { radii, colors, spacing, fields } = useTheme();
const [expanded, setExpanded] = useState(false);
const editor = useMemo(
() => createDocumentEditor(documentFeatures, componentBlocks, relationships),
Expand All @@ -196,10 +196,11 @@ export function DocumentEditor({
<div
css={[
{
display: 'flex',
flexDirection: 'column',
border: `1px solid ${colors.border}`,
borderRadius: radii.small,
},
expanded && {
border: 'none',
background: colors.background,
bottom: 0,
left: 0,
Expand Down Expand Up @@ -248,12 +249,36 @@ export function DocumentEditor({
)}

<DocumentEditorEditable
css={
expanded && {
marginLeft: spacing.medium,
marginRight: spacing.medium,
}
}
css={[
{
borderRadius: 'inherit',
background: fields.inputBackground,
borderColor: fields.inputBorderColor,
paddingLeft: spacing.medium,
paddingRight: spacing.medium,
':hover': {
background: fields.hover.inputBackground,
},
':focus': {
background: fields.focus.inputBackground,
},
':disabled': {
background: fields.disabled.inputBackground,
},
},
expanded
? {
height: 'auto !important',
background: fields.focus.inputBackground,
}
: {
height: 224,
resize: 'vertical',
overflowY: 'auto',
minHeight: 120,
scrollbarGutter: 'stable',
},
]}
{...props}
readOnly={onChange === undefined}
/>
Expand Down
17 changes: 11 additions & 6 deletions packages/fields-document/src/DocumentEditor/primitives/toolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,12 @@ export const ToolbarSeparator = () => {
// Groups
// ------------------------------

const autoFlowDirection = {
column: 'row',
row: 'column',
type DirectionType = 'row' | 'column';

const directionToAlignment = {
row: 'center',
column: 'start',
};
type DirectionType = keyof typeof autoFlowDirection;

const ToolbarGroupContext = createContext<{ direction: DirectionType }>({ direction: 'row' });
const useToolbarGroupContext = () => useContext(ToolbarGroupContext);
Expand All @@ -51,9 +52,12 @@ export const ToolbarGroup = forwardRefWithAs<'div', ToolbarGroupProps>(
<Box
ref={ref}
css={{
display: 'inline-grid',
display: 'flex',
gap: spacing.xxsmall,
gridAutoFlow: autoFlowDirection[direction],
flexDirection: direction,
justifyContent: 'start',
alignItems: directionToAlignment[direction],
height: '100%',
}}
{...props}
>
Expand Down Expand Up @@ -146,6 +150,7 @@ export const ToolbarButton = forwardRefWithAs<'button', ToolbarButtonProps>(func
'&[data-display-mode=column]': {
paddingLeft: spacing.medium,
paddingRight: spacing.medium,
width: '100%',
},
}}
{...props}
Expand Down