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

[core] feat(EditableText): new HTML prop "contentId" #4935

Merged
merged 2 commits into from
Sep 28, 2021
Merged

[core] feat(EditableText): new HTML prop "contentId" #4935

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
2974c2c
[core] Allow passing an ID attribute to underlying text content in Ed…
styu Sep 28, 2021
93c56c5
rename to contentId
styu Sep 28, 2021
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
14 changes: 12 additions & 2 deletions packages/core/src/components/editable-text/editableText.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ export interface IEditableTextProps extends IntentProps, Props {
/** Text value of controlled input. */
value?: string;

/** ID attribute to pass to the underlying element that contains the text contents. This allows for referencing via aria attributes */
contentId?: string;

/** Callback invoked when user cancels input with the `esc` key. Receives last confirmed value. */
onCancel?(value: string): void;

Expand Down Expand Up @@ -204,7 +207,7 @@ export class EditableText extends AbstractPureComponent2<EditableTextProps, IEdi
}

public render() {
const { alwaysRenderInput, disabled, multiline } = this.props;
const { alwaysRenderInput, disabled, multiline, contentId } = this.props;
const value = this.props.value ?? this.state.value;
const hasValue = value != null && value !== "";

Expand Down Expand Up @@ -243,11 +246,18 @@ export class EditableText extends AbstractPureComponent2<EditableTextProps, IEdi
// and size the container element responsively
const shouldHideContents = alwaysRenderInput && !this.state.isEditing;

const spanProps: React.HTMLProps<HTMLSpanElement> = contentId != null ? { id: contentId } : {};

return (
<div className={classes} onFocus={this.handleFocus} tabIndex={tabIndex}>
{alwaysRenderInput || this.state.isEditing ? this.renderInput(value) : undefined}
{shouldHideContents ? undefined : (
<span className={Classes.EDITABLE_TEXT_CONTENT} ref={this.refHandlers.content} style={contentStyle}>
<span
{...spanProps}
className={Classes.EDITABLE_TEXT_CONTENT}
ref={this.refHandlers.content}
style={contentStyle}
>
{hasValue ? value : this.props.placeholder}
</span>
)}
Expand Down
5 changes: 5 additions & 0 deletions packages/core/test/editable-text/editableTextTests.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@ describe("<EditableText>", () => {
assert.strictEqual(editable.text(), "placeholder");
});

it("passes an ID to the underlying span", () => {
const editable = shallow(<EditableText disabled={true} isEditing={true} contentId="my-id" />).find("span");
assert.strictEqual(editable.prop("id"), "my-id");
});

describe("when editing", () => {
it('renders <input type="text"> when editing', () => {
const input = shallow(<EditableText isEditing={true} />).find("input");
Expand Down