palantir/blueprint

EditableText: support additional editing customisation [feature request]

Open

#1,393 opened on Jul 27, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (2,167 forks)batch import
Package: coreType: enhancementhelp wanted

Repository metrics

Stars
 (20,263 stars)
PR merge metrics
 (Avg merge 43d 10h) (27 merged PRs in 30d)

Description

It would be convenient to have more control around the edit process.

My motivating example is to differentiate display-value vs edit-value; for example display a formatted currency string "$1,234.50", but present the raw number (1234.5) for editing.

I can think of a few possibilities off the top of my head to implement this:

  • an optional format function
  • different properties for display and editing values
  • a callback fired before editing starts
  • (more involved) a different component for editing, meaning you could also use a select list on edit, or a colour picker, etc

I'm not sure which might be the best solution, if this is desirable functionality, but I'm happy to work on a patch for feedback if necessary.

Contributor guide

Research direction
Explore the EditableText component implementation and consider adding an optional format function or separate displayValue and editValue props. Prototype a solution and gather feedback.
Tech stack
typescriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60