Skip to content
ReactJS based Presentation Library
JavaScript HTML
Branch: master
Clone or download
johnstonmatt fix tutorial link (#832)
relative path to tutorial was wrong, creating a dead link to the tutorial
Latest commit 8135025 Feb 12, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update docs to include `!raw-loader!` hack (#681) May 29, 2019
__mocks__ Added ComponentPlayground. Jan 18, 2017
docs fix tutorial link (#832) Feb 12, 2020
example apply styles to child in SlideSet (#669) Apr 6, 2019
src Upgrade React Live to v2 (#800) Jan 14, 2020
.babelrc Build: Add ESM files + babel updates. (#493) Mar 20, 2018
.eslintignore update eslintignore to exclude lib files Aug 30, 2018
.eslintrc Add react-static content for deploying docs (#786) Jan 8, 2020
.gitignore Infra: Deploy to prod. Fix slug generation and numbers. (#797) Jan 10, 2020
.npmignore Include index.d.ts in package (#647) Jan 18, 2019
.prettierignore Update travis + prettier stuff. (#532) Jun 5, 2018
.prettierrc updated contributing Apr 11, 2018
.travis.yml Infra: Switch to spectacle-ci AWS user. (#822) Jan 29, 2020
CONTRIBUTING.md Add bulletStyle types, doc updates (#703) Jul 31, 2019
LICENSE Add typescript types (#630) Dec 28, 2018
README.md Add correct sub-dir to Readme link paths, fixes #801 (#803) Jan 16, 2020
index.d.ts add deck option to disable touch events (#745) Oct 30, 2019
index.html Remove specialized zoom handling and margins for slide content (#611) Dec 3, 2018
index.js Update travis + prettier stuff. (#532) Jun 5, 2018
jest-setup.js Handle warning: Add raf polyfill Oct 13, 2017
one-page.html Update one-page.html to use spectacle 5 (#687) Jun 17, 2019
package.json 5.8.0 Jan 14, 2020
tslint.json Add typescript types (#630) Dec 28, 2018
webpack.config.js gif support (#497) Dec 10, 2018
webpack.config.production.js gif support (#497) Dec 10, 2018
webpack.config.umd.js gif support (#497) Dec 10, 2018
webpack.config.umd.production.js Update travis + prettier stuff. (#532) Jun 5, 2018
yarn.lock Upgrade React Live to v2 (#800) Jan 14, 2020

README.md

Spectacle

Travis Status Maintenance Status

A ReactJS-based Presentation Library.

Looking for a quick preview of what you can do with Spectacle? Check out our live Demo Deck here.

Have a question about Spectacle? Submit an issue in this repository using the "Question" template.

Contents

FAQ

How can I easily style the base components for my presentation?

Historically, custom styling in Spectacle has meant screwing with a theme file, or using !important overrides. We fixed that. Spectacle is now driven by emotion, so you can bring your own styling library, whether it's emotion itself, or something like styled-components or glamorous. For example, if you want to create a custom Heading style:

import styled from 'react-emotion';
import { Heading } from 'spectacle';

const CustomHeading = styled(Heading)`
  font-size: 1.2em;
  color: papayawhip;
`;

Can I write my presentation in TypeScript?

Yes, you can! Type definitions are shipped with the library, so you can import Spectacle components into any .tsx presentation without additional installation steps.

Updated type definitions for the Spectacle API can be found at the root of this repository.

Maintenance Status

Active: Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.

You can’t perform that action at this time.