Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Task](context): Double check prop types #664

Closed
Tracked by #541
guoda-puidokaite opened this issue Dec 5, 2024 · 1 comment
Closed
Tracked by #541

[Task](context): Double check prop types #664

guoda-puidokaite opened this issue Dec 5, 2024 · 1 comment
Assignees
@guoda-puidokaite

Comments

@guoda-puidokaite
Copy link
Contributor

guoda-puidokaite commented Dec 5, 2024 •
edited
Loading

Task Description

  • Double check types in ui-components assigned during TS migration.
  • Open ticket for component type feedback.

Type considerations:

  • Make types simple and user friendly (no unnecessary type declarations e.g. ReactNode | string or ReactNode | undefined for optional props).
  • Make types broad unless necessary to restrict.
  • Future-poof
  • Breaking type changes are okay as not many apps use TS.

Sub-tasks

  • Components:

    • packages/ui-components/src/components/AppBody
    • packages/ui-components/src/components/AppShell
    • packages/ui-components/src/components/AppShellProvider
    • packages/ui-components/src/components/Badge
    • packages/ui-components/src/components/Box
    • packages/ui-components/src/components/Breadcrumb
    • packages/ui-components/src/components/BreadcrumbItem
    • packages/ui-components/src/components/Button
    • packages/ui-components/src/components/ButtonRow
    • packages/ui-components/src/components/Checkbox
    • packages/ui-components/src/components/CheckboxGroup
    • packages/ui-components/src/components/Code
    • packages/ui-components/src/components/CodeBlock
    • packages/ui-components/src/components/ComboBox
    • packages/ui-components/src/components/ComboBoxOption
    • packages/ui-components/src/components/Container
    • packages/ui-components/src/components/ContentAreaToolbar
    • packages/ui-components/src/components/ContentContainer
    • packages/ui-components/src/components/ContentHeading
    • packages/ui-components/src/components/DataGrid
    • packages/ui-components/src/components/DataGridCell
    • packages/ui-components/src/components/DataGridCheckboxCell
    • packages/ui-components/src/components/DataGridFoot
    • packages/ui-components/src/components/DataGridHeadCell
    • packages/ui-components/src/components/DataGridRow
    • packages/ui-components/src/components/DataGridToolbar
    • packages/ui-components/src/components/DateTimePicker
    • packages/ui-components/src/components/Form
    • packages/ui-components/src/components/FormattedText
    • packages/ui-components/src/components/FormHint
    • packages/ui-components/src/components/FormRow
    • packages/ui-components/src/components/FormSection
    • packages/ui-components/src/components/Grid
    • packages/ui-components/src/components/GridColumn
    • packages/ui-components/src/components/GridRow
    • packages/ui-components/src/components/HeaderContainer
    • packages/ui-components/src/components/Icon
    • packages/ui-components/src/components/InputGroup
    • packages/ui-components/src/components/IntroBox
    • packages/ui-components/src/components/JsonViewer
    • packages/ui-components/src/components/Label
    • packages/ui-components/src/components/LoadingIndicator
    • packages/ui-components/src/components/MainContainer
    • packages/ui-components/src/components/MainContainerInner (No Story)
    • packages/ui-components/src/components/MainTabs
    • packages/ui-components/src/components/Message
    • packages/ui-components/src/components/Modal
    • packages/ui-components/src/components/ModalFooter
    • packages/ui-components/src/components/NativeSelect
    • packages/ui-components/src/components/NativeSelectOption
    • packages/ui-components/src/components/NativeSelectOptionGroup
    • packages/ui-components/src/components/Navigation
    • packages/ui-components/src/components/NavigationItem
    • packages/ui-components/src/components/PageFooter
    • packages/ui-components/src/components/PageHeader
    • packages/ui-components/src/components/Pagination
    • packages/ui-components/src/components/Panel
    • packages/ui-components/src/components/PanelBody
    • packages/ui-components/src/components/PanelFooter
    • packages/ui-components/src/components/Pill
    • packages/ui-components/src/components/PopupMenu
    • packages/ui-components/src/components/PortalProvider
    • packages/ui-components/src/components/Radio
    • packages/ui-components/src/components/RadioGroup
    • packages/ui-components/src/components/SearchInput
    • packages/ui-components/src/components/SecretText
    • packages/ui-components/src/components/Select
    • packages/ui-components/src/components/SelectDivider
    • packages/ui-components/src/components/SelectOption
    • packages/ui-components/src/components/ShadowRoot
    • packages/ui-components/src/components/SideNavigation
    • packages/ui-components/src/components/SideNavigationItem
    • packages/ui-components/src/components/Spinner
    • packages/ui-components/src/components/Stack
    • packages/ui-components/src/components/StyleProvider
    • packages/ui-components/src/components/Switch
    • packages/ui-components/src/components/Tab
    • packages/ui-components/src/components/TabList
    • packages/ui-components/src/components/TabNavigation
    • packages/ui-components/src/components/TabNavigationItem
    • packages/ui-components/src/components/TabPanel
    • packages/ui-components/src/components/Tabs
    • packages/ui-components/src/components/Textarea
    • packages/ui-components/src/components/TextInput
    • packages/ui-components/src/components/ThemeToggle
    • packages/ui-components/src/components/Toast
    • packages/ui-components/src/components/Tooltip
    • packages/ui-components/src/components/TooltipContent
    • packages/ui-components/src/components/TooltipTrigger
    • packages/ui-components/src/components/TopNavigation
    • packages/ui-components/src/components/TopNavigationItem
    • packages/ui-components/src/components/withDeprecationWarning

  • Double check children:

    • packages/ui-components/src/components/DataGrid/DataGrid.component.tsx
    • packages/ui-components/src/components/DataGridCell/DataGridCell.component.tsx
    • packages/ui-components/src/components/DataGridFoot/DataGridFoot.component.tsx
    • packages/ui-components/src/components/DataGridHeadCell/DataGridHeadCell.component.tsx
    • packages/ui-components/src/components/DataGridRow/DataGridRow.component.tsx
    • packages/ui-components/src/components/DataGridToolbar/DataGridToolbar.component.tsx
    • packages/ui-components/src/components/MainTabs/MainTabs.component.tsx
    • packages/ui-components/src/components/Navigation/Navigation.component.tsx
    • packages/ui-components/src/components/NavigationItem/NavigationItem.component.tsx
    • packages/ui-components/src/components/Tab/Tab.component.tsx
    • packages/ui-components/src/components/TabList/TabList.component.tsx
    • packages/ui-components/src/components/TabPanel/TabPanel.component.tsx
    • packages/ui-components/src/components/Tabs/Tabs.component.tsx

Related Issues
#168

Additional Context
Add any other context or information here.
@guoda-puidokaite guoda-puidokaite mentioned this issue Dec 5, 2024
Closed
60 tasks
@guoda-puidokaite guoda-puidokaite self-assigned this Dec 9, 2024
This was referenced Jan 13, 2025
Closed
Open
@guoda-puidokaite guoda-puidokaite mentioned this issue Jan 21, 2025
Closed
4 tasks
This was referenced Jan 30, 2025
Merged
Merged
@guoda-puidokaite guoda-puidokaite changed the title [Task](context): Double check types [Task](context): Double check prop types Feb 5, 2025
@guoda-puidokaite guoda-puidokaite mentioned this issue Feb 10, 2025
Open
3 tasks
@guoda-puidokaite
Copy link
Contributor Author

guoda-puidokaite commented Feb 11, 2025 •
edited
Loading

Please read PR descriptions of actual changes made:

Further issues and improvements regarding types can be tracked in this ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@guoda-puidokaite guoda-puidokaite

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@guoda-puidokaite