idyll-langidyll
DocsTutorialsGalleryEditor
menu

Overview

  • Introduction
  • Getting started
  • Markup syntax
  • HTML tags
  • Options and styles
  • Plugin system
  • Multipage template

Interactivity

  • Built-in components
  • Using components from npm
  • Make your own component
  • Scrolling and Refs

Publishing

  • Deploying to the web
  • Embedding Idyll

Useful Links

  • Github
  • Chat
  • Twitter
  • Support Us

Installing Components from NPM

Additional components can be installed via npm.

Suggested Components

  • Apparatus
  • Vega Lite

Details

Because Idyll is built on top of React, any React component can be used in Idyll. If you install a component using npm, Idyll will automatically be able to find it without any additional configuration.

For example:

$ npm install some-react-component

This could then be used in your markup as

[SomeReactComponent /]

Internally, this is equivalent to require('some-react-component'). If you need to access a property of the imported module, you can do it like this:

[SomeReactComponent.nested.Property /]

This is equivalent to require('some-react-component').nested.Property.

Continue to custom components.