Skip to content

Add TypeScript typings #2675

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

Merged
merged 1 commit into from
Jan 22, 2021

Conversation

volkanunsal
Copy link
Contributor

Additional description


CONTRIBUTOR checklist (do not remove)

Please complete for every pull request

  • First-time contributors should sign the Contributor License Agreement. It's a fancy way of saying that you are giving away your contribution to this project. If you haven't before, wait a few minutes and a bot will comment on this pull request with instructions.
  • npm run lint:fix has been run and linting passes.
  • Mocha, Jest (Storyshots), and components/component-docs.json CI tests pass (npm test).
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.

REVIEWER checklist (do not remove)

  • TravisCI tests pass. This includes linting, Mocha, Jest, Storyshots, and components/component-docs.json tests.
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.
Required only if there are markup / UX changes
  • Add year-first date and commit SHA to last-slds-markup-review in package.json and push.
  • Request a review of the deployed Heroku app by the Salesforce UX Accessibility Team.
  • Add year-first review date, and commit SHA, last-accessibility-review, to package.json and push.
  • While the contributor's branch is checked out, run npm run local-update within locally cloned site repo to confirm the site will function correctly at the next release.

@welcome
Copy link

welcome bot commented Nov 5, 2020

Thanks for opening this pull request! 💯

This is a community-driven project, and we can't do it without your participation. Please check out our contributing guidelines and review the Contributor Checklist if you haven't already, to make sure everything is squared away. TravisCI will take about 10 minutes to run through the same items that are on the Contributor checklist with a pass/fail check below. Please fix any issues that cause TravisCI to fail or ask for clarification--we try, but sometimes the errors can be unclear.
A maintainer will try to respond within 7 days. If you haven’t heard anything by then, please bump this thread. To ensure codebase quality, large code line changes may take more than 2 weeks to review, but may take longer depending on the number of pull requests in the queue. Feel free to ask for a status update at any time--you won't be bothering anyone.
Once feedback has been given, please reply to the feedback giver once the feedback on been addressed, so that they can continue the review.
If you need a release while you are waiting for a code review, you can publish a built tag to your own fork. See directions in the release README.

@salesforce-cla
Copy link

salesforce-cla bot commented Nov 5, 2020

Thanks for the contribution! Unfortunately we can't verify the commit author(s): Volkan Unsal <v***@A***.com>. One possible solution is to add that email to your GitHub account. Alternatively you can change your commits to another email and force push the change. After getting your commits associated with your GitHub account, sign the Salesforce.com Contributor License Agreement and this Pull Request will be revalidated.

@salesforce-cla
Copy link

salesforce-cla bot commented Nov 5, 2020

Thanks for the contribution! Before we can merge this, we need @volkanunsal to sign the Salesforce.com Contributor License Agreement.

@volkanunsal volkanunsal force-pushed the typescript-typings branch 2 times, most recently from 076e41c to d0c7e40 Compare November 5, 2020 13:24
@rthadr
Copy link
Contributor

rthadr commented Jan 18, 2021

It would be awesome if someone could merge this.

@garygong
Copy link
Contributor

@interactivellama Could you take a look at this PR? Thanks a lot!

@interactivellama interactivellama changed the title Add typings Add TypeScript typings Jan 22, 2021
@interactivellama interactivellama self-requested a review January 22, 2021 22:22
@interactivellama
Copy link
Contributor

Will review and test this out, over the weekend.

@interactivellama
Copy link
Contributor

interactivellama commented Jan 22, 2021

Adding the following, so folks in the future know how to use this:

import ButtonType from '@salesforce/design-system-react/components/button';
import AccordionType from '@salesforce/design-system-react/components/accordion';
export const Button: ButtonType;
export const Accordion: AccordionType;

Also, adding that these are not being dynamically generated and may become out of date soon.

@interactivellama
Copy link
Contributor

Fixes #1346

@interactivellama interactivellama merged commit 5b9dde4 into salesforce:master Jan 22, 2021
@welcome
Copy link

welcome bot commented Jan 22, 2021

Congrats on merging your first pull request to Design System React! 🎉
If you have a moment, please fill out this five question survey, we would appreciate it.
On behalf of Salesforce's customers, partners, product specialists and employees, we would like offer sincere thanks and appreciation for helping make our user experience better. We look forward to working with you more in the future.
This definitely calls for a high five! Alt High Five

@interactivellama
Copy link
Contributor

@volkanunsal Would you be willing to share how these types were generated?

@volkanunsal
Copy link
Contributor Author

volkanunsal commented Jan 23, 2021 via email

@volkanunsal volkanunsal deleted the typescript-typings branch January 23, 2021 02:27
@volkanunsal volkanunsal restored the typescript-typings branch January 23, 2021 02:27
@volkanunsal volkanunsal deleted the typescript-typings branch January 23, 2021 02:27
@Sm1t
Copy link

Sm1t commented Sep 23, 2021

I wrote a few comby scripts to extract them from the js files. Then did some manual cleanup. I can share them if there is interest.

@volkanunsal I'm very interested, can you please share these utilities?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants