Skip to content

Commit 2d331fc

Browse files
committed
docs: add doc comments on types
1 parent ecbd2f1 commit 2d331fc

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

src/Shared/types.ts

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -748,23 +748,68 @@ export interface CustomRoleAndMeta {
748748
}
749749

750750
interface CommonTabArgsType {
751+
/**
752+
* Name for the tab.
753+
*
754+
* Note: Used for the title
755+
*/
751756
name: string
752757
kind?: string
758+
/**
759+
* URL for the tab
760+
*/
753761
url: string
762+
/**
763+
* If true, the tab is selected
764+
*/
754765
isSelected: boolean
766+
/**
767+
* Title for the tab
768+
*/
755769
title?: string
756770
isDeleted?: boolean
771+
/**
772+
* Type for the tab
773+
*
774+
* Note: Fixed tabs are always places before dynamic tabs
775+
*/
757776
type: 'fixed' | 'dynamic'
777+
/**
778+
* Path of the icon for the tab
779+
*
780+
* @default ''
781+
*/
758782
iconPath?: string
783+
/**
784+
* Dynamic title for the tab
785+
*
786+
* @default ''
787+
*/
759788
dynamicTitle?: string
789+
/**
790+
* Whether to show the tab name when selected
791+
*
792+
* @default false
793+
*/
760794
showNameOnSelect?: boolean
761795
/**
796+
* Would remove the title/name from tab heading, but that does not mean name is not required, since it is used in other calculations
762797
* @default false
763798
*/
764799
hideName?: boolean
800+
/**
801+
* Indicates if showNameOnSelect tabs have been selected once
802+
*
803+
* @default false
804+
*/
765805
isAlive?: boolean
766806
lastSyncMoment?: Dayjs
767807
componentKey?: string
808+
/**
809+
* Custom tippy config for the tab
810+
*
811+
* This overrides the tippy being computed from tab title
812+
*/
768813
tippyConfig?: {
769814
title: string
770815
descriptions: {

0 commit comments

Comments
 (0)