rsnext/examples/with-react-md-typescript
Luc Leray f52955ec94
Clean up examples package.json (#27121)
Clean up package.json files in the `examples` directory:
- Add `private: true`
- Remove `version` (because they are irrelevant for packages that are not meant to be published)
- Remove `name` (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale)
- Remove `author`
- Remove `description`
- Remove `license`

Also remove `with-dynamic-app-layout` example completely, since it does the same as `layout-component` (https://github.com/vercel/next.js/pull/27121#discussion_r668178408).

## Documentation / Examples

- [x] Make sure the linting passes
2021-07-12 19:58:03 +00:00
..
components [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
pages [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
styles [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
.gitignore [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
next-env.d.ts [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
package.json Clean up examples package.json (#27121) 2021-07-12 19:58:03 +00:00
README.md docs: add 'Open in StackBlitz' buttons to various examples (#25853) 2021-06-08 20:45:02 +00:00
tsconfig.json Update tsconfig of example to be consistent with default output of next.js (#25581) 2021-06-03 22:31:14 +00:00

ReactMD, Next.js, and Typescript Example

This example sets up a simple ReactMD, Next.js, and Typescript app featuring:

  • _variables.scss to override the default react-md theme and feature toggles
  • app.scss global styles that conditionally apply the dark theme based on the user's OS preferences
  • a custom _app.tsx that uses a persistent layout
  • a reusable Layout.tsx that:
    • updates all the icons to use SVGIcons instead of FontIcons
    • initializes the Layout component from react-md with navigation items

For more information about ReactMD's features, styling, components, and API, check out the main documentation. You can also view the documentation site's source code for a more complex example of using ReactMD + Next.js.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example with-react-md-typescript with-react-md-typescript-app
# or
yarn create next-app --example with-react-md-typescript with-react-md-typescript-app

Deploy it to the cloud with Vercel (Documentation).