Repository navigation
Excerpt Generation: Move generation into its own sidebar panel with a review modal #1139
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.
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
Closed
ntsekouras
wants to merge
2
commits into
WordPress:develop
from
ntsekouras:update-excerpt-gen-like-meta-description
Closed
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
72 changes: 0 additions & 72 deletions
72
src/experiments/excerpt-generation/components/ExcerptGeneration.tsx
This file was deleted.
Oops, something went wrong.
176 changes: 176 additions & 0 deletions
176
src/experiments/excerpt-generation/components/ExcerptGenerationModal.tsx
This file contains hidden or 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,176 @@ | ||
| /** | ||
| * Modal component for generating and editing an excerpt suggestion. | ||
| */ | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { useEffect } from '@wordpress/element'; | ||
| import { __ } from '@wordpress/i18n'; | ||
| import { Modal, Button, TextareaControl, Notice } from '@wordpress/components'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { useCopyToClipboardFeedback } from '../../../hooks/use-copy-to-clipboard-feedback'; | ||
|
|
||
| interface ExcerptGenerationModalProps { | ||
| isGenerating: boolean; | ||
| suggestion: string | null; | ||
| editableText: string; | ||
| isContentTooShort: boolean; | ||
| tooShortLabel: string; | ||
| onEditableTextChange: ( text: string ) => void; | ||
| onGenerate: () => Promise< void >; | ||
| onApply: ( text: string ) => void; | ||
| onClose: () => void; | ||
| } | ||
|
|
||
| function CopyButton( { | ||
| text, | ||
| disabled, | ||
| }: { | ||
| text: string; | ||
| disabled: boolean; | ||
| } ): JSX.Element { | ||
| const { ref, hasCopied } = useCopyToClipboardFeedback< HTMLButtonElement >( | ||
| { | ||
| text, | ||
| announcement: __( 'Excerpt copied to clipboard.', 'ai' ), | ||
| } | ||
| ); | ||
|
|
||
| const isCopyDisabled = disabled || hasCopied; | ||
|
|
||
| return ( | ||
| <Button | ||
| ref={ isCopyDisabled ? undefined : ref } | ||
| variant="tertiary" | ||
| disabled={ isCopyDisabled } | ||
| accessibleWhenDisabled | ||
| __next40pxDefaultSize | ||
| > | ||
| { hasCopied | ||
| ? __( 'Copied!', 'ai' ) | ||
| : __( 'Copy to clipboard', 'ai' ) } | ||
| </Button> | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Modal for generating and editing an excerpt. | ||
| * | ||
| * @param props Component props. | ||
| * @param props.isGenerating Whether generation is in progress. | ||
| * @param props.suggestion The generated suggestion. | ||
| * @param props.editableText The current editable text value. | ||
| * @param props.isContentTooShort Whether the content is too short to generate a suggestion. | ||
| * @param props.tooShortLabel Label to show when content is too short. | ||
| * @param props.onEditableTextChange Callback to update the editable text. | ||
| * @param props.onGenerate Callback to trigger generation. | ||
| * @param props.onApply Callback to apply the excerpt. | ||
| * @param props.onClose Callback to close the modal. | ||
| */ | ||
| export default function ExcerptGenerationModal( { | ||
| isGenerating, | ||
| suggestion, | ||
| editableText, | ||
| isContentTooShort, | ||
| tooShortLabel, | ||
| onEditableTextChange, | ||
| onGenerate, | ||
| onApply, | ||
| onClose, | ||
| }: ExcerptGenerationModalProps ): React.JSX.Element { | ||
| // Populate the textarea when a new suggestion arrives. | ||
| useEffect( () => { | ||
| if ( suggestion ) { | ||
| onEditableTextChange( suggestion ); | ||
| } | ||
| }, [ suggestion, onEditableTextChange ] ); | ||
|
|
||
| let generateButtonLabel: string = suggestion | ||
| ? __( 'Regenerate', 'ai' ) | ||
| : __( 'Generate', 'ai' ); | ||
|
|
||
| if ( isGenerating ) { | ||
| generateButtonLabel = __( 'Generating…', 'ai' ); | ||
| } | ||
|
|
||
| return ( | ||
| <Modal | ||
| title={ __( 'Excerpt generation', 'ai' ) } | ||
| onRequestClose={ onClose } | ||
| className="ai-excerpt-generation-modal" | ||
| size="medium" | ||
| focusOnMount="firstContentElement" | ||
| > | ||
| <div className="ai-excerpt-generation-modal__content"> | ||
| { isContentTooShort && ( | ||
| <Notice status="warning" isDismissible={ false }> | ||
| { tooShortLabel } | ||
| </Notice> | ||
| ) } | ||
|
|
||
| <TextareaControl | ||
| label={ __( 'Excerpt', 'ai' ) } | ||
| hideLabelFromVision | ||
| value={ editableText } | ||
| onChange={ onEditableTextChange } | ||
| rows={ 5 } | ||
| disabled={ isGenerating } | ||
| /> | ||
|
|
||
| <div className="ai-excerpt-generation-modal__actions"> | ||
| <Button | ||
| variant="primary" | ||
| onClick={ () => { | ||
| onApply( editableText ); | ||
| onClose(); | ||
| } } | ||
| accessibleWhenDisabled | ||
| disabled={ | ||
| isGenerating || | ||
| ( !! editableText && | ||
| editableText.trim().length === 0 ) | ||
| } | ||
| __next40pxDefaultSize | ||
| > | ||
| { __( 'Apply', 'ai' ) } | ||
| </Button> | ||
| <Button | ||
| variant="secondary" | ||
| label={ | ||
| isContentTooShort | ||
| ? tooShortLabel | ||
| : generateButtonLabel | ||
| } | ||
| showTooltip | ||
| onClick={ onGenerate } | ||
| disabled={ isGenerating || isContentTooShort } | ||
| isBusy={ isGenerating } | ||
| accessibleWhenDisabled | ||
| __next40pxDefaultSize | ||
| > | ||
| { generateButtonLabel } | ||
| </Button> | ||
| <CopyButton | ||
| text={ editableText } | ||
| disabled={ | ||
| isGenerating || editableText.trim().length === 0 | ||
| } | ||
| /> | ||
| <Button | ||
| variant="tertiary" | ||
| isDestructive | ||
| onClick={ onClose } | ||
| className="ai-excerpt-generation-modal__cancel" | ||
| __next40pxDefaultSize | ||
| > | ||
| { __( 'Cancel', 'ai' ) } | ||
| </Button> | ||
| </div> | ||
| </div> | ||
| </Modal> | ||
| ); | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not for this PR, but some components could be reused across experiments. I think it would help with UI consistency without the risk of drifting.