-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: Code editor to edit site (#37765)
- Loading branch information
1 parent
afa6767
commit 8d7dc99
Showing
16 changed files
with
399 additions
and
10 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
packages/edit-site/src/components/code-editor/code-editor-text-area.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import Textarea from 'react-autosize-textarea'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { __ } from '@wordpress/i18n'; | ||
| import { useState } from '@wordpress/element'; | ||
| import { useInstanceId } from '@wordpress/compose'; | ||
| import { VisuallyHidden } from '@wordpress/components'; | ||
|
|
||
| export default function CodeEditorTextArea( { value, onChange, onInput } ) { | ||
| const [ stateValue, setStateValue ] = useState( value ); | ||
| const [ isDirty, setIsDirty ] = useState( false ); | ||
| const instanceId = useInstanceId( CodeEditorTextArea ); | ||
|
|
||
| if ( ! isDirty && stateValue !== value ) { | ||
| setStateValue( value ); | ||
| } | ||
|
|
||
| /** | ||
| * Handles a textarea change event to notify the onChange prop callback and | ||
| * reflect the new value in the component's own state. This marks the start | ||
| * of the user's edits, if not already changed, preventing future props | ||
| * changes to value from replacing the rendered value. This is expected to | ||
| * be followed by a reset to dirty state via `stopEditing`. | ||
| * | ||
| * @see stopEditing | ||
| * | ||
| * @param {Event} event Change event. | ||
| */ | ||
| const onChangeHandler = ( event ) => { | ||
| const newValue = event.target.value; | ||
| onInput( newValue ); | ||
| setStateValue( newValue ); | ||
| setIsDirty( true ); | ||
| }; | ||
|
|
||
| /** | ||
| * Function called when the user has completed their edits, responsible for | ||
| * ensuring that changes, if made, are surfaced to the onPersist prop | ||
| * callback and resetting dirty state. | ||
| */ | ||
| const stopEditing = () => { | ||
| if ( isDirty ) { | ||
| onChange( stateValue ); | ||
| setIsDirty( false ); | ||
| } | ||
| }; | ||
|
|
||
| return ( | ||
| <> | ||
| <VisuallyHidden | ||
| as="label" | ||
| htmlFor={ `code-editor-text-area-${ instanceId }` } | ||
| > | ||
| { __( 'Type text or HTML' ) } | ||
| </VisuallyHidden> | ||
| <Textarea | ||
| autoComplete="off" | ||
| dir="auto" | ||
| value={ stateValue } | ||
| onChange={ onChangeHandler } | ||
| onBlur={ stopEditing } | ||
| className="edit-site-code-editor-text-area" | ||
| id={ `code-editor-text-area-${ instanceId }` } | ||
| placeholder={ __( 'Start writing with text or HTML' ) } | ||
| /> | ||
| </> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { parse } from '@wordpress/blocks'; | ||
| import { useEntityBlockEditor, useEntityProp } from '@wordpress/core-data'; | ||
| import { useSelect, useDispatch } from '@wordpress/data'; | ||
| import { store as keyboardShortcutsStore } from '@wordpress/keyboard-shortcuts'; | ||
| import { __ } from '@wordpress/i18n'; | ||
| import { Button } from '@wordpress/components'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { store as editSiteStore } from '../../store'; | ||
| import CodeEditorTextArea from './code-editor-text-area'; | ||
|
|
||
| export default function CodeEditor() { | ||
| const { templateType, shortcut } = useSelect( ( select ) => { | ||
| const { getEditedPostType } = select( editSiteStore ); | ||
| const { getShortcutRepresentation } = select( keyboardShortcutsStore ); | ||
| return { | ||
| templateType: getEditedPostType(), | ||
| shortcut: getShortcutRepresentation( 'core/edit-site/toggle-mode' ), | ||
| }; | ||
| }, [] ); | ||
| const [ contentStructure, setContent ] = useEntityProp( | ||
| 'postType', | ||
| templateType, | ||
| 'content' | ||
| ); | ||
| const [ blocks, , onChange ] = useEntityBlockEditor( | ||
| 'postType', | ||
| templateType | ||
| ); | ||
| const content = | ||
| contentStructure instanceof Function | ||
| ? contentStructure( { blocks } ) | ||
| : contentStructure; | ||
| const { switchEditorMode } = useDispatch( editSiteStore ); | ||
| return ( | ||
| <div className="edit-site-code-editor"> | ||
| <div className="edit-site-code-editor__toolbar"> | ||
| <h2>{ __( 'Editing code' ) }</h2> | ||
| <Button | ||
| variant="tertiary" | ||
| onClick={ () => switchEditorMode( 'visual' ) } | ||
| shortcut={ shortcut } | ||
| > | ||
| { __( 'Exit code editor' ) } | ||
| </Button> | ||
| </div> | ||
| <div className="edit-site-code-editor__body"> | ||
| <CodeEditorTextArea | ||
| value={ content } | ||
| onChange={ ( newContent ) => { | ||
| onChange( parse( newContent ), { | ||
| selection: undefined, | ||
| } ); | ||
| } } | ||
| onInput={ setContent } | ||
| /> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } |
100 changes: 100 additions & 0 deletions
100
packages/edit-site/src/components/code-editor/style.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| .edit-site-code-editor { | ||
| position: relative; | ||
| width: 100%; | ||
| background-color: $white; | ||
| flex-grow: 1; | ||
|
|
||
| &__body { | ||
| width: 100%; | ||
| padding: 0 $grid-unit-15 $grid-unit-15 $grid-unit-15; | ||
| max-width: $break-xlarge; | ||
| margin-left: auto; | ||
| margin-right: auto; | ||
|
|
||
| @include break-large() { | ||
| padding: $grid-unit-20 $grid-unit-30 #{ $grid-unit-60 * 2 } $grid-unit-30; | ||
| padding: 0 $grid-unit-30 $grid-unit-30 $grid-unit-30; | ||
| } | ||
| } | ||
|
|
||
| // Exit code editor toolbar. | ||
| &__toolbar { | ||
| position: sticky; | ||
| z-index: z-index(".edit-site-code-editor__toolbar"); | ||
| top: 0; | ||
| left: 0; | ||
| right: 0; | ||
| display: flex; | ||
| background: rgba($white, 0.8); | ||
| padding: $grid-unit-05 $grid-unit-15; | ||
|
|
||
| @include break-small() { | ||
| padding: $grid-unit-15; | ||
| } | ||
|
|
||
| @include break-large() { | ||
| padding: $grid-unit-15 $grid-unit-30; | ||
| } | ||
|
|
||
| h2 { | ||
| line-height: $button-size; | ||
| margin: 0 auto 0 0; | ||
| font-size: $default-font-size; | ||
| color: $gray-900; | ||
| } | ||
|
|
||
| .components-button svg { | ||
| order: 1; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| textarea.edit-site-code-editor-text-area.edit-site-code-editor-text-area { | ||
| border: $border-width solid $gray-600; | ||
| border-radius: 0; | ||
| display: block; | ||
| margin: 0; | ||
| width: 100%; | ||
| box-shadow: none; | ||
| resize: none; | ||
| overflow: hidden; | ||
| font-family: $editor-html-font; | ||
| line-height: 2.4; | ||
| min-height: 200px; | ||
| transition: border 0.1s ease-out, box-shadow 0.1s linear; | ||
| @include reduce-motion("transition"); | ||
|
|
||
| // Same padding as title. | ||
| padding: $grid-unit-20; | ||
| @include break-small() { | ||
| padding: $grid-unit-30; | ||
| } | ||
|
|
||
| /* Fonts smaller than 16px causes mobile safari to zoom. */ | ||
| font-size: $mobile-text-min-font-size !important; | ||
| @include break-small { | ||
| font-size: $text-editor-font-size !important; | ||
| } | ||
|
|
||
| &:focus { | ||
| border-color: var(--wp-admin-theme-color); | ||
| box-shadow: 0 0 0 var(--wp-admin-border-width-focus) var(--wp-admin-theme-color); | ||
|
|
||
| // Elevate the z-index on focus so the focus style is uncropped. | ||
| position: relative; | ||
| } | ||
|
|
||
| &::-webkit-input-placeholder { | ||
| color: $dark-gray-placeholder; | ||
| } | ||
|
|
||
| &::-moz-placeholder { | ||
| color: $dark-gray-placeholder; | ||
| // Override Firefox default. | ||
| opacity: 1; | ||
| } | ||
|
|
||
| &:-ms-input-placeholder { | ||
| color: $dark-gray-placeholder; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.