Skip to content

feat(table): add TypeScript definitions for table fields #2867

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
Merged
merged 19 commits into from
Apr 4, 2019
Merged

feat(table): add TypeScript definitions for table fields #2867

merged 19 commits into from
Apr 4, 2019

Conversation

mattgrande
Copy link
Contributor

@mattgrande mattgrande commented Mar 18, 2019 •
edited by tmorehouse
Loading

Description of Pull Request:

I had basically already created these TS definitions within my own project, before realising I should probably create this as a PR.

I'm not super familiar with TS + Vue, so if there's a better way to declare what I'm doing on line 142 for Vue Components, please let me know.

PR checklist:

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement to an existing feature
  • ARIA accessibility
  • Documentation update
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact:

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e.
    fixes #xxxx[,#xxxx], where "xxxx" is the issue number)
  • The PR should address only one issue or feature. If adding multiple features or fixing a bug
    and adding a new feature, break them into separate PRs if at all possible.
  • PR titles should following the
    Conventional Commits naming convention (i.e.
    "fix(alert): not alerting during SSR render", "docs(badge): Updated pill examples, fix typos",
    "chore: fix typo in docs", etc). This is very important, as the CHANGELOG is generated
    from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and
    event changes)
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (does it affect screen reader users or
    keyboard only users? clickable items should be in the tab index, etc)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a
    suggestion issue first and wait for approval before working on it)

@codecov
Copy link

codecov bot commented Mar 18, 2019 •
edited
Loading

Codecov Report

Merging #2867 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##             dev   #2867   +/-   ##
=====================================
  Coverage   98.2%   98.2%           
=====================================
  Files        205     205           
  Lines       3685    3685           
  Branches    1105    1105           
=====================================
  Hits        3619    3619           
  Misses        46      46           
  Partials      20      20

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 547477b...aa37c29. Read the comment docs.

@jacobmllr95 jacobmllr95 changed the title feat(table): Add TypeScript definitions for table fields feat(table): add TypeScript definitions for table fields Mar 18, 2019
@jacobmllr95 jacobmllr95 requested a review from tmorehouse March 18, 2019 15:45
tmorehouse
tmorehouse reviewed Mar 19, 2019
View reviewed changes
tmorehouse
tmorehouse reviewed Mar 19, 2019
View reviewed changes
tmorehouse
tmorehouse reviewed Mar 19, 2019
View reviewed changes
iliveoncaffiene
iliveoncaffiene reviewed Mar 19, 2019
View reviewed changes
Matt Grande and others added 4 commits March 19, 2019 09:32
Changes from code review
5274dad 
VueVariant -> TableVariant
interface TableFieldArray -> type TableFieldArray
Make fields optional
Merge branch 'feat/table-field-ts' of https://github.com/mattgrande/b…
33734c3 
…ootstrap-vue into feat/table-field-ts
@tmorehouse
Update README.md
1eaec1f
@tmorehouse
Update README.md
8340795
iliveoncaffiene
iliveoncaffiene reviewed Mar 19, 2019
View reviewed changes
tmorehouse
tmorehouse reviewed Mar 19, 2019
View reviewed changes
tmorehouse
tmorehouse reviewed Mar 19, 2019
View reviewed changes
@mattgrande
Copy link
Contributor Author

I think I've taken care of everything mentioned above; Please let me know if I've missed anything!

@jacobmllr95 jacobmllr95 requested a review from tmorehouse March 24, 2019 13:53
tmorehouse
tmorehouse reviewed Mar 24, 2019
View reviewed changes
tmorehouse
tmorehouse reviewed Mar 24, 2019
View reviewed changes
tmorehouse
tmorehouse reviewed Mar 24, 2019
View reviewed changes
@iliveoncaffiene iliveoncaffiene mentioned this pull request Mar 28, 2019
Closed
@jacobmllr95 jacobmllr95 requested a review from tmorehouse April 4, 2019 08:53
tmorehouse
tmorehouse approved these changes Apr 4, 2019
View reviewed changes
Copy link
Member

@tmorehouse tmorehouse left a comment

Choose a reason for hiding this comment

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

I don't think we have everything covered here, but it is a decent start.

@jacobmllr95 jacobmllr95 merged commit 436e8c1 into bootstrap-vue:dev Apr 4, 2019
@jacobmllr95
Copy link
Member

Thanks @mattgrande!

@mattgrande
Copy link
Contributor Author

Thanks! 🎉

@ldawkes
Copy link
Contributor

ldawkes commented Apr 8, 2019

@mattgrande What version of TypeScript are you using? Because as far as I'm aware TypeScript doesn't have the mixed keyword, so TypeScript 3.4 now fails the type check because this change introduces an invalid keyword.

You should use any if you're going to imply a mix of types that can be returned.

@b-89 b-89 mentioned this pull request Apr 16, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iliveoncaffiene iliveoncaffiene iliveoncaffiene left review comments

@tmorehouse tmorehouse tmorehouse approved these changes

Assignees
No one assigned
Labels
Type: Enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mattgrande @jacobmllr95 @ldawkes @tmorehouse @iliveoncaffiene