Skip to content

Add a Type definition for uiType used in the text-editor #3293

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
john-traas merged 4 commits into from
Nov 14, 2024
Merged

Add a Type definition for uiType used in the text-editor #3293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f54092d
feat(text-editor): add uiType as a type
john-traas Nov 12, 2024
0f503e0
feat(text-editor): use uiType in editor
john-traas Nov 12, 2024
6b070d1
docs(text editor): update ui typing
john-traas Nov 12, 2024
ccee848
Merge branch 'main' into add-ui-types-as-a-type
hannahu Nov 14, 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
7 changes: 5 additions & 2 deletions etc/lime-elements.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ export namespace Components {
"required"?: boolean;
// @alpha
"triggers": TriggerCharacter[];
"ui"?: 'standard' | 'minimal';
"ui"?: EditorUiType;
"value": string;
}
// @beta
Expand Down Expand Up @@ -761,6 +761,9 @@ export type EditorTextLink = {
href: string;
};

// @beta (undocumented)
export type EditorUiType = 'standard' | 'minimal';

// Warning: (ae-missing-release-tag) "EventEmitter" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down Expand Up @@ -1683,7 +1686,7 @@ namespace JSX_2 {
"required"?: boolean;
// @alpha
"triggers"?: TriggerCharacter[];
"ui"?: 'standard' | 'minimal';
"ui"?: EditorUiType;
"value"?: string;
}
// @beta
Expand Down
3 changes: 2 additions & 1 deletion src/components/text-editor/text-editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { Languages } from '../date-picker/date.types';
import { createRandomString } from '../../util/random-string';
import { CustomElementDefinition } from '../../global/shared-types/custom-element.types';
import { TriggerCharacter, TriggerEventDetail } from './text-editor.types';
import { EditorUiType } from './types';

/**
* A rich text editor that offers a rich text editing experience with markdown support,
Expand Down Expand Up @@ -151,7 +152,7 @@ export class TextEditor implements FormComponent<string> {
* until the editor is focused.
*/
@Prop({ reflect: true })
public ui?: 'standard' | 'minimal' = 'standard';
public ui?: EditorUiType = 'standard';

/**
* Dispatched when a change is made to the editor
Expand Down
5 changes: 5 additions & 0 deletions src/components/text-editor/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ import { CustomElementDefinition } from '../../global/shared-types/custom-elemen
export type TextEditorPlugin = {
node: CustomElementDefinition[];
};

/**
* @beta
*/
export type EditorUiType = 'standard' | 'minimal';
Copy link
Contributor

@jgroth jgroth Nov 12, 2024

Choose a reason for hiding this comment

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

There's a missing release tag on this type