Allow setting theme options

[daun]

Description

Allow passing in theme options as second argument:

{
  theme: ['overlay', { direction: 'to-right' }]
}

Checks

• [x] The PR is submitted to the master branch
• [x] The code was linted before pushing (npm run lint)
• [ ] All tests are passing (npm run test)
• [ ] New or updated tests are included
• [x] The documentation was updated as required

Additional information

Closes #11

[hirasso]

Why did you decide for the array form? I think I'd prefer a more explicit object like

{
  name: string,
  options: object
}

[daun]

@hirasso Mostly to keep it compact. I spent so much time in ESLint configs lately where the format of tuples for config also just felt natural:

"no-undef": ["error", { "typeof": true }]

Your suggestion is valid as well and is actually what I had implemented at some point. What bothered me about it was that customizing a single theme option would turn a single line into six lines if formatted normally. That's just a lot of visual noise, I felt like.

{
  // Before
  theme: 'overlay',

  // After
  theme: {
    name: 'overlay',
    options: {
      direction: 'to-right'
    }
  },

  // Versus
  theme: ['overlay', { direction: 'to-right' }]
}

[hirasso]

It's probably a matter of taste. I prefer clarity over density most of the time.

[daun]

@hirasso Definitely. If the thought of a tuple for this makes you shudder, feel free to push to this branch and I'll happily accept it. While I have a strong preference for it in this single case, I'm not opposed to the object version either.

[hirasso]

If you feel strongly about it, lets go with it.