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
← Back

Header

This component makes it easy to add a title, subtitle, and byline to your article:

Input:

[Header
  title:"The Title of my Article"
  subtitle:"The subtitle of my article"
  author:"Matthew Conlen"
  authorLink:"https://github.com/mathisonian/"
  /]

Output:

Props

  • title string

    • Example: "Article Title"
  • subtitle string

    • Example: "Article subtitle."
  • author string

    • authorLink string

      • authors array

        An array of authors. Each element of the array can be an object or a string.

        • Example: `[{name: 'Jane Doe', link: 'https://website.com'}]`
      • date string

        The publication date.

        • Example: "December 25, 2018"
      • background string

        The background of the header. Can pass a color or a url().

        • Example: "#999"
      • byLineTemplate object

        Optional template to use in by line.

        • Example: `{ prefix: 'Made by', joint: ' ', suffix: '&' }`
      • color string

        The text color of the header.

        • Example: "#000"