palantir/blueprint

Dev mode warning for Tooltip wrapping a disabled Button

Open

#3,494 opened on Apr 23, 2019

View on GitHub
 (0 comments) (2 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: APIP2Package: coreType: enhancementhelp wanted

Description

Even though it's well-documented, the issue comes up frequently: https://github.com/palantir/blueprint/issues/967#issuecomment-485615346

We should log a warning in development mode, suggesting use of an AnchorButton instead. Writing a lint rule seems like it would be harder than introspecting the React tree at runtime.

cc @thelastnode

Contributor guide

Tech stack
reacttypescript
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactBlueprint componentsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Implement a dev mode warning in the Tooltip component that checks if its children include a disabled Button. Inspect the Tooltip component source in the Blueprint repository (likely in packages/core/src/components/tooltip). Use React.Children or React.Children.forEach to iterate over children and check if any element is a Button with disabled prop. If so, log a warning suggesting AnchorButton. Look at existing dev warnings in Blueprint (e.g., using the debug package or process.env.NODE ENV) to maintain consistency.
Dev mode warning for Tooltip wrapping a disabled Button · palantir/blueprint#3494 | Good First Issue