Skip to main content

View as Markdown · AI documentation index

Type Alias: StoryOptions

StoryOptions = object

Defined in: packages/core/src/passages/story/types.ts:1039

Configuration options for story appearance and behavior. Applied to the entire story passage.

Example​

const options: StoryOptions = {
  background: {
    image: '/backgrounds/forest.jpg'
  },
  classNames: {
    base: 'min-h-screen bg-cover bg-center',
    container: 'max-w-4xl mx-auto p-8'
  }
};

newStory('forest-scene', () => [...], options);

Properties​

background?​

optional background: object

Defined in: packages/core/src/passages/story/types.ts:1043

Background configuration for the story.

image?​

optional image: string | () => string

URL or path to the background image. Can be a static string or a function that returns a string for dynamic backgrounds.

Example​
// Static background
image: '/backgrounds/castle.jpg'

// Dynamic background based on game state
image: () => player.location === 'night'
  ? '/backgrounds/castle-night.jpg'
  : '/backgrounds/castle-day.jpg'

classNames?​

optional classNames: object

Defined in: packages/core/src/passages/story/types.ts:1065

CSS class name overrides for story layout.

base?​

optional base: string

CSS class for the outermost story container. Controls overall layout, background, and viewport settings.

Example​
base: 'min-h-screen flex items-center justify-center bg-gradient-to-b from-blue-900 to-black'

container?​

optional container: string

CSS class for the inner content container. Controls content width, padding, and component spacing.

Example​
container: 'max-w-2xl p-6 bg-card/90 backdrop-blur-sm rounded-xl shadow-2xl'