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

Button typescript definition of ml prop #3727

Closed
PaulSumner-Sage opened this issue Feb 19, 2021 · 3 comments · Fixed by #3837
Closed

Button typescript definition of ml prop #3727

PaulSumner-Sage opened this issue Feb 19, 2021 · 3 comments · Fixed by #3837
Labels
Bug On Backlog released

Comments

@PaulSumner-Sage
Copy link
Contributor

Current behaviour

with the removal of the sibling margins

The ml typescript definition for margins is:

/** Margin bottom, given number will be multiplied by base spacing unit (8) */
 mb?: 0 | 1 | 2 | 3 | 4 | 5 | 7;
/** Margin left, any valid CSS value */
 ml?: string;

ml?: string overrides the SpacingProps extension for number | string meaning we can't put what is in the Carbon story page examples of ml={2} without getting a typescript error

Expected behaviour

Typescript definition of ml prop to match Carbon story page

Suggested solution(s)

Update the prop to match the inherited SpacingProps number | string

Your environment

Software Version(s)
carbon-react v66.7
carbon-factory
react-scripts
React
Browser
npm
Operating System
@PaulSumner-Sage PaulSumner-Sage added Bug triage Triage Required labels Feb 19, 2021
@samtjo samtjo mentioned this issue Feb 23, 2021
Closed
@samtjo
Copy link
Contributor

samtjo commented Feb 23, 2021

This should cover both the mb and the ml prop. The solution is simply to remove them from the Button Typescript interface, because it already extends SpacingProps

@ian-forster
Copy link
Contributor

FE-2818

@ian-forster ian-forster added On Backlog and removed triage Triage Required labels Feb 25, 2021
grabkowski added a commit that referenced this issue Apr 9, 2021
@grabkowski
fix(button): incorrect ts margin type definitions
920d165 
remove margin type definitions
remove onClick type definition that is not available in the propTypes
add documentation for type definitions

Fixes #3727
@grabkowski grabkowski mentioned this issue Apr 14, 2021
Merged
3 tasks
grabkowski added a commit that referenced this issue May 6, 2021
@grabkowski
fix(button): incorrect ts margin type definitions
fb055df 
remove margin type definitions
remove onClick type definition that is not available in the propTypes
add documentation for type definitions

Fixes #3727
grabkowski added a commit that referenced this issue May 11, 2021
@grabkowski
fix(button): incorrect ts margin type definitions
1fa2e36 
remove margin type definitions
remove onClick type definition that is not available in the propTypes
add documentation for type definitions

Fixes #3727
carbonci pushed a commit that referenced this issue May 11, 2021
@semantic-release-bot @carbonci
chore(release): 72.0.0
dcb8555 
## [72.0.0](v71.4.2...v72.0.0) (2021-05-11)

### ⚠ BREAKING CHANGES

* all TypeScript projects have to add @types/styled-system
and @types/styled-components as dev dependencies

### Features

* **validation-icon:** add ts type definitions ([15a9f81](15a9f81))
* add global style type definition file ([169a3f5](169a3f5))
* add type definitions to mockmatchmedia util ([205a000](205a000))
* **action-toolbar:** add ts type definitions ([0050574](0050574))
* **alert:** add ts type definitions ([c35be8e](c35be8e))
* **app-wrapper:** add ts type definitions ([dbbcc30](dbbcc30)), closes [#3696](#3696)
* **button-toggle:** add ts type definitions ([f289949](f289949))
* **button-toggle-group:** add ts type definitions ([1ca5da7](1ca5da7))
* **card:** add ts type definitions ([fc6129b](fc6129b))
* **carousel:** add ts type definitions ([7c5490a](7c5490a))
* **checkable-input:** add type definitions ([16421e3](16421e3))
* **configurable-items:** add ts type definitions ([890aaa5](890aaa5))
* **detail:** add ts type definitions ([ffc91d6](ffc91d6))
* **dialog:** add ts type definitions ([e8b7192](e8b7192))
* **dialog-full-screen:** add ts type definitions ([37ffe53](37ffe53)), closes [#3697](#3697)
* **duelling-picklist:** add picklist-group ts type definitions ([a08ca70](a08ca70))
* **form-field:** add type definitions ([f6ba4f9](f6ba4f9))
* **heading:** add ts type definitions ([9598cc3](9598cc3)), closes [#3699](#3699)
* **icon-button:** add ts type definitions ([1c18a99](1c18a99))
* **inline-inpouts:** add ts type definitions ([bbd8fef](bbd8fef))
* **loader:** add ts type definitions ([c5e0ada](c5e0ada)), closes [#3700](#3700)
* **menu:** add scrollableblock type definitions ([348f91e](348f91e))
* **message:** add ts type definitions ([12cdd01](12cdd01)), closes [#3701](#3701)
* **modal:** add ts type definitions ([108bec4](108bec4))
* **mount-in-app:** add ts type definitions ([2b4aacd](2b4aacd))
* **multi-action-button:** add ts type definitions ([2598a7f](2598a7f))
* **pages:** add ts type definitions ([2a3f736](2a3f736))
* **portal:** add ts type definitions ([c769de8](c769de8))
* **preview:** add ts type definitions ([b653c65](b653c65))
* **profile:** add ts type definitions ([74baa19](74baa19))
* **settings-row:** add ts type definitions ([85822c9](85822c9))
* **show-edit-pod:** add ts type definitions ([7bd13b2](7bd13b2))
* **sidebar:** add ts type definitions ([cc69fc1](cc69fc1)), closes [#3702](#3702)
* **simple-select:** add select-textbox type definitions ([a100cc9](a100cc9))
* **split-button:** add ts type definitions ([0598f16](0598f16))
* **step-sequence:** add ts type definitions ([29c40b2](29c40b2))
* add ts type definitions to theme config files ([b62b21a](b62b21a)), closes [#3705](#3705)

### Bug Fixes

* **accordion:** incorrect ts type definitions ([fec618f](fec618f))
* **action-popover:** incorrect ts type definitions ([7f520c2](7f520c2))
* **advanced-color-picker:** incorrect ts type definitions ([4fbe849](4fbe849))
* **anchor-navigation:** incorrect ts type definitions ([fc68fdd](fc68fdd))
* **badge:** incorrect ts type definitions ([b3cdc6e](b3cdc6e))
* **batch-selection:** ts type definitions not properly exported ([7b59608](7b59608))
* **box:** ts type definitions not properly exported ([b0dc5e6](b0dc5e6)), closes [#3733](#3733)
* **button:** incorrect ts margin type definitions ([1fa2e36](1fa2e36)), closes [#3727](#3727)
* **checkbox-group:** incorrect children type in typescript ([cc480c5](cc480c5))
* **confirm:** type definitions not exported ([befd66e](befd66e)), closes [#3710](#3710) [#3809](#3809)
* **draggable:** incorrect ts type definitions ([e855976](e855976))
* **drawer:** incorrect ts type definitions ([6e4ab56](6e4ab56)), closes [#3694](#3694)
* **flat-table:** missing ts type definitions ([088183e](088183e))
* **form:** type definitions not properly exported ([01c07ed](01c07ed)), closes [#3690](#3690)
* **hr:** type definitions not properly exported ([9dce2b9](9dce2b9)), closes [#3691](#3691)
* **link:** internallink export missing in type definitions ([37002c1](37002c1))
* **number:** incorrect import of textbox type definitions ([984f9db](984f9db))
* **pill:** ts type definitions not properly exported ([379efd3](379efd3)), closes [#3708](#3708)
* **popover-container:** type definitions not properly exported ([c127258](c127258)), closes [#3707](#3707)
* **radio-button:** type definitions not properly exported ([3873c81](3873c81))
* **simple-select:** optionrow and optiongroupheader type definitions not exported ([8143417](8143417))
* **tabs:** ts props other than children should be optional ([df5a6b8](df5a6b8)), closes [#3568](#3568)
* **tile-select:** ts type prop should not be required ([3e7343b](3e7343b))
* **toast:** type definitions not properly exported ([a9b3dfe](a9b3dfe)), closes [#3712](#3712)
* **typography:** incorrect prop name in type definitions ([afcebf4](afcebf4))
* incorrect typescript exports ([cd60012](cd60012))

### Miscellaneous Chores

* add styled-system and styled-components types dependencies ([fc8e62d](fc8e62d))
@carbonci
Copy link
Collaborator

🎉 This issue has been resolved in version 72.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug On Backlog released
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: typescript fixes - FE-2818 Sage/carbon
4 participants
@samtjo @ian-forster @PaulSumner-Sage @carbonci