Skip to content

Update docs to reference local type definitions #632

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

Merged
merged 1 commit into from
Jan 3, 2019
Merged

Update docs to reference local type definitions #632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Thanks for taking the time to help us make Spectacle even better! Before you go

- Run the tests using `yarn run test`.
- Run lint and flow using `yarn run lint`
- Open a PR in [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/spectacle/index.d.ts) for anything that modifies the Spectacle API, like breaking changes or new features.
- Update the [type definitions](./index.d.ts) for anything that modifies the Spectacle API, like breaking changes or new features.
- Everything else included in our [pull request checklist](https://github.com/FormidableLabs/spectacle/blob/master/.github/PULL_REQUEST_TEMPLATE.md#checklist-feel-free-to-delete-this-section-upon-completion)

## Releasing a new version to NPM (only for project administrators)
Expand Down
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,11 +453,9 @@ const CustomHeading = styled(Heading)`

**_Can I write my presentation in TypeScript?_**

Yes, you can! Updated type definitions for the Spectacle API can be found within [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/spectacle/index.d.ts). You can bring them into your project using `yarn` or `npm`:
Yes, you can! Type definitions are shipped with the library, so you can import Spectacle components into any `.tsx` presentation without additional installation steps.

```sh
npm i --save @types/spectacle
```
Updated type definitions for the Spectacle API can be found [at the root of this repository](./index.d.ts).

## Tag API

Expand Down