CalciteFlowItem.showBackButton causes type error in public types #10801
Labels
4 - verified
Issues that have been released and confirmed resolved.
ArcGIS Maps SDK for JavaScript
Issues logged by ArcGIS SDK for JavaScript team members.
bug
Bug reports for broken functionality. Issues should include a reproduction of the bug.
calcite-components
Issues specific to the @esri/calcite-components package.
estimate - 1
Very small fix or change (potentially a single line), doesn't require updates to tests.
impact - p1 - need for current milestone
User set priority impact status of p1 - need for current milestone
p - high
Issue should be addressed in the current milestone, impacts component or core functionality
Milestone
Check existing issues
Actual Behavior
Consuming Calcite's
dev
branch typings in JS API produces this TypeScript error:The
showBackButton
property is marked as private, which makes it excluded from public typings:calcite-design-system/packages/calcite-components/src/components/flow-item/flow-item.tsx
Lines 133 to 138 in b280ea4
Solutions:
showBackButton
as@internal
rather than@private
- it will still be present in the typings, but you can can be excluded when rendering the public documentation.FlowItemLike
interface to not rely onshowBackButton
(or at least not in the way that produces a typescript error when that property is absent)Expected Behavior
Do not produce TypeScript errors when consuming Calcite typings in a project that has
"skipLibCheck": false
Reproduction Sample
(JS API PR 66756)
Reproduction Steps
Simplest way to reproduce is to comment out the
showBackButton
property from the CalciteFlowItem component to simulate how it would appear in the public typings.Otherwise, you can try
npx build:ts
on thecalcite-lumina
branch in JS API (PR 66756)Reproduction Version
3.0.0-next.12
Relevant Info
No response
Regression?
No response
Priority impact
impact - p1 - need for current milestone
Impact
No response
Calcite package
Esri team
ArcGIS Maps SDK for JavaScript
The text was updated successfully, but these errors were encountered: