palantir/blueprint

Typings on PanelStack2 are not working as explain in documentation

Open

#5359 opened on Jun 7, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
P1Package: coreType: bughelp wanted

Description

Environment

  • Package version(s): core 4.4.1
  • Operating System: MacOS Monterrey 12.3.1
  • Browser name and version: Chrome Version 102.0.5005.61

Code Sandbox

(https://codesandbox.io/s/spring-sun-vomre1?file=/src/App.tsx)

Steps to reproduce

  1. Create a component and add a PanelStack2
  2. Add a custom panel component with his own typing props (e.g: ComponentType) using PanelProps<ComponentType>
  3. Try adding this custom panel as initial panel

Actual behavior

You will face this type error: Type 'PanelProps' is not assignable to type 'PanelProps'.

Expected behavior

Types should be ok as it's following, the docs. I also think it should be ok to define Panel as :

type MainPanelProps = {
  loading: boolean;
};

const MainPanel = (props: PanelProps<MainPanelProps>) => {
  return <div />;
};

Possible solution

🤷‍♂️ Sorry, i have no idea.

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
bug
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.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic TypeScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Explore the type definitions for PanelStack2, likely in files such as `panelStack2.tsx` or related type files under `src/components/panel stack2/`. The issue describes a mismatch between `PanelProps<object>` and `PanelProps<ComponentType>`. Investigate the generic parameter constraints on `Panel` and `PanelStack2` to ensure the initial panel's type parameter is correctly inferred or propagated. Reference the provided CodeSandbox for reproduction.