Skip to content

Add function to inserter to stopTrigger #3305

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

Merged
adrianschmidt merged 2 commits into from
Nov 26, 2024
Merged

Add function to inserter to stopTrigger #3305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93e1521
feat(text editor): add stopTrigger function to inserter factory
john-traas Nov 18, 2024
cbb2b90
docs(text-editor): use new stopTrigger
civing Nov 26, 2024
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
2 changes: 2 additions & 0 deletions etc/lime-elements.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2413,6 +2413,8 @@ export interface TabPanelComponent {
// @alpha (undocumented)
export interface TextEditor {
insert: (input: TextEditorNode | string) => void;
// (undocumented)
stopTrigger: () => void;
Copy link
Contributor

@adrianschmidt adrianschmidt Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I know this PR is still WIP, I just happened to see it.)

This change should be part of the first commit, not a separate commit 🤗

Copy link
Contributor Author

@john-traas john-traas Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll fix that up 🤗

Copy link
Contributor

@civing civing Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you okey with the interface @adrianschmidt ?

Copy link
Contributor

@adrianschmidt adrianschmidt Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I've got no problem with it 😄

Maybe it ought to be documented? But it's still @alpha, so not a show-stopper I guess 🙂

}

// @alpha (undocumented)
Expand Down
1 change: 1 addition & 0 deletions src/components/text-editor/examples/text-editor-custom-triggers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ export class TextEditorCustomTriggersExample {

if (event.key === ESCAPE) {
this.isPickerOpen = false;
this.triggerFunction?.stopTrigger();
}
};

Expand Down
8 changes: 8 additions & 0 deletions src/components/text-editor/prosemirror-adapter/plugins/trigger/inserter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ export const inserterFactory = (view: EditorView): TextEditor => {
transaction.setMeta('stopTrigger', true);
dispatch(transaction);
},
stopTrigger: () => {
const { state, dispatch } = view;

const transaction = state.tr;
transaction.setMeta('stopTrigger', true);

dispatch(transaction);
},
};
};

Expand Down
1 change: 1 addition & 0 deletions src/components/text-editor/text-editor.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export interface TextEditor {
*
*/
insert: (input: TextEditorNode | string) => void;
stopTrigger: () => void;
}

/**
Expand Down
Loading