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.

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

Comments: allow customize placeholder for input box #92794

Closed
rebornix opened this issue Mar 16, 2020 · 4 comments
Closed

Comments: allow customize placeholder for input box #92794

rebornix opened this issue Mar 16, 2020 · 4 comments
Assignees
Labels
api-finalization comments Comments Provider/Widget/Panel issues feature-request Request for new features or functionality verified Verification succeeded
Milestone

Comments

@rebornix
Copy link
Member

Issue Type: Feature Request

Currently the inputbox always shows Reply ... as the place holder while extensions might want to customize that. This can be done either through static contribution or through API.

VS Code version: Code - Insiders 1.44.0-insider (798481c, 2020-03-16T07:10:59.884Z)
OS version: Darwin x64 19.2.0

@rebornix rebornix added feature-request Request for new features or functionality comments Comments Provider/Widget/Panel issues labels Mar 16, 2020
@rebornix rebornix self-assigned this Mar 16, 2020
@vscodebot vscodebot bot added this to the Backlog Candidates milestone Mar 16, 2020
@vscodebot
Copy link

vscodebot bot commented Mar 16, 2020

This feature request is now a candidate for our backlog. The community has 60 days to upvote the issue. If it receives 20 upvotes we will move it to our backlog. If not, we will close it. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

@rebornix
Copy link
Member Author

rebornix commented Apr 8, 2020

The commenting api now has interesting usage like CodeTour which is no longer just about code commenting thus the default placeholder we use for the input box might confuse CodeTour (and other similar extensions) customers, thus we are going to make this customizable. The proposal is introducing an option property for CommentController

export interface CommentOptions {
    /**
     * An optional string to show on the comment input box when it's collapsed.
     */
     prompt?: string;

    /**
     * An optional string to show as placeholder in the comment input box when it's focused.
     */
     placeHolder?: string;
}

export interface CommentController {
    /**
     * Comment controller options
     */
     options?: CommentOptions;
}

@lostintangent
Copy link
Member

@rebornix Does this new API allow hiding the reply functionality entirely? Or simply changing the prompt text that is displayed?

@rebornix
Copy link
Member Author

rebornix commented May 5, 2020

@lostintangent no, this will only control the display text but not if the comment thread is readonly or not. I would imagine that's another metadata.

@rebornix rebornix reopened this May 5, 2020
@rebornix rebornix modified the milestones: April 2020, May 2020 May 5, 2020
@jrieken jrieken added the verified Verification succeeded label Jun 2, 2020
@github-actions github-actions bot locked and limited conversation to collaborators Jun 19, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api-finalization comments Comments Provider/Widget/Panel issues feature-request Request for new features or functionality verified Verification succeeded
Projects
None yet
Development

No branches or pull requests

3 participants