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.

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

react-ui: Add component typings #663

Merged
merged 6 commits into from
May 9, 2023
Merged

react-ui: Add component typings #663

merged 6 commits into from
May 9, 2023

Conversation

zbigg
Copy link
Contributor

@zbigg zbigg commented May 4, 2023

Description

Shortcut: https://app.shortcut.com/cartoteam/story/306547

Provide proper typings for following components from @carto/react-ui:

  • Button
  • LabelWithIndicator
  • PasswordField
  • SelectField
  • Typography
  • AccordionGroup
  • Avatar
  • UploadField
  • AppBar

Also export all *Props definitions in same manner as MUI does.

image

Type of change

(choose one and remove the others)

  • Fix
  • Feature

Acceptance

When importing import { Typography } from '@carto/react-ui' the type of component should be properly detected by IDE and tsc compiler

Basic checklist

  • Good PR name
  • Shortcut link
  • Changelog entry
  • Just one issue per PR
  • GitHub labels
  • Proper status & reviewers
  • Tests
  • Documentation

@zbigg zbigg requested a review from vmilan May 4, 2023 13:53
@coveralls
Copy link
Collaborator

coveralls commented May 4, 2023

Pull Request Test Coverage Report for Build 4923407154

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 72.015%

Totals Coverage Status
Change from base Build 4917872875: 0.0%
Covered Lines: 2017
Relevant Lines: 2579

💛 - Coveralls

@zbigg zbigg requested a review from VictorVelarde May 4, 2023 14:05
Copy link
Contributor

@vmilan vmilan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this improvement!!

@zbigg zbigg force-pushed the zbigg/typography-typings branch 2 times, most recently from 2ec6ffa to 1792ee1 Compare May 8, 2023 13:03
@zbigg zbigg changed the title react-ui: Typography typings react-ui: Add component typings May 8, 2023
@zbigg zbigg requested review from vmilan and VictorVelarde May 8, 2023 14:07
@zbigg zbigg force-pushed the zbigg/typography-typings branch from 1792ee1 to 7d4fdbe Compare May 8, 2023 15:06
Copy link
Contributor

@VictorVelarde VictorVelarde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. If already finished, add a note to changelog and land into master @zbigg

@zbigg zbigg force-pushed the zbigg/typography-typings branch from 469d054 to acda191 Compare May 9, 2023 07:15
@zbigg zbigg merged commit 879672f into master May 9, 2023
@zbigg zbigg deleted the zbigg/typography-typings branch May 9, 2023 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants