Taggor

All components · Category: Content and utilities

Scroll story

A story told step by step by scrolling inside its own box.

Steps are told by scrolling inside the component's own box while a number and a ring beside them follow along. Every step's text is in the page, buttons jump to a step, and the page itself never scrolls because of it.

01

Try it

<scroll-story>
View

Props

Accent
Corners
scroll-story: A story told step by step by scrolling inside its own box. A picture of the real component, drawn from its own code. The controls change the picture and the code beside it; nothing here is sent or stored.

Generated from the component's manifest and the values above.

Code for

index.html

<scroll-story locale="en"></scroll-story>

<script>
  const element = document.querySelector("scroll-story");
  element.addEventListener("scroll-story:step", (event) => {
    console.log(event.detail);
  });
</script>
  • Add the site's Taggor script once; the component appears when it loads.

taggor-component.js

const element = document.createElement("scroll-story");
element.setAttribute("locale", "en");
element.addEventListener("scroll-story:step", (event) => {
  console.log(event.detail);
});
document.body.append(element);
  • Add the site's Taggor script once; the component appears when it loads.

ScrollStory.tsx

import { useEffect, useRef } from "react";

export function ScrollStory() {
  const ref = useRef<HTMLElement>(null);

  useEffect(() => {
    const element = ref.current;
    if (!element) return;
    const onStep = (event: Event) => {
      console.log((event as CustomEvent).detail);
    };
    element.addEventListener("scroll-story:step", onStep);
    return () => {
      element.removeEventListener("scroll-story:step", onStep);
    };
  }, []);

  return <scroll-story ref={ref} locale="en" />;
}
  • Add the site's Taggor script once; the component appears when it loads.
  • React 18 sends every prop of a custom element as a text attribute.
  • The event is heard with addEventListener, inside an effect.

ScrollStory.tsx

import { useEffect, useRef } from "react";

export function ScrollStory() {
  const ref = useRef<HTMLElement>(null);

  useEffect(() => {
    const element = ref.current;
    if (!element) return;
    const onStep = (event: Event) => {
      console.log((event as CustomEvent).detail);
    };
    element.addEventListener("scroll-story:step", onStep);
    return () => {
      element.removeEventListener("scroll-story:step", onStep);
    };
  }, []);

  return <scroll-story ref={ref} locale="en" />;
}
  • Add the site's Taggor script once; the component appears when it loads.
  • React 19 sets a property when the element already has it, an attribute otherwise.
  • The event is heard with addEventListener, inside an effect.

src/ScrollStory.vue

<script setup lang="ts">
function onStep(event: Event) {
  console.log((event as CustomEvent).detail);
}
</script>

<template>
  <scroll-story locale="en" @scroll-story:step="onStep" />
</template>

vite.config.ts

import vue from "@vitejs/plugin-vue";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: (tag) => tag === "scroll-story",
        },
      },
    }),
  ],
});
  • Add the site's Taggor script once; the component appears when it loads.
  • vite.config.ts tells Vue that this tag is not a Vue component.

src/app/scroll-story.component.ts

import { afterNextRender, Component, CUSTOM_ELEMENTS_SCHEMA, DestroyRef, ElementRef, inject } from "@angular/core";

@Component({
  selector: "app-scroll-story",
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
  template: `
    <scroll-story locale="en"></scroll-story>
  `,
})
export class ScrollStoryComponent {
  constructor() {
    const host = inject<ElementRef<HTMLElement>>(ElementRef);
    const element = () => host.nativeElement.querySelector("scroll-story");
    const onStep = (event: Event) => {
      console.log((event as CustomEvent).detail);
    };
    afterNextRender(() => element()?.addEventListener("scroll-story:step", onStep));
    inject(DestroyRef).onDestroy(() => element()?.removeEventListener("scroll-story:step", onStep));
  }
}
  • Add the site's Taggor script once; the component appears when it loads.
  • The component declares CUSTOM_ELEMENTS_SCHEMA.
  • The event is heard with addEventListener, inside an effect.

src/TaggorComponent.svelte

<script>
  function onStep(event) {
    console.log(event.detail);
  }
</script>

<scroll-story locale="en" onscroll-story:step={onStep}></scroll-story>
  • Add the site's Taggor script once; the component appears when it loads.

How an agent gets a component like this onto a site:

taggor checktaggor publish

The CSS variables the component exposes, set the way a customer's page would.

styles.css

scroll-story {
  --ss-radius: 18px;
}

02

Props

Props of the component, read from its manifest
PropTypeDefaultWhat it does
stepslistnoneThe steps (2 to 6): a title and a text.
heightnumber 12 to 3218Height of the story box, in em.
localept-BR | enen–

Prop names and descriptions are the component's own, in English, as its author wrote them.

03

Events

Events of the component, read from its manifest
EventWhen it fires
stepAnother step came into view.

04

Build one with your agent

Paste this into your agent. It asks you before it signs in, pays or goes further than checking and publishing.

Build me a Taggor component like "Scroll story" (scroll-story): A story told step by step by scrolling inside its own box. Fetch https://taggor.dev/agent-setup/prompt.md and follow its instructions to set me up for Taggor. Ask me before you sign in, create an account, accept terms, pay for anything or type a secret. Check it with `taggor check` and publish it with `taggor publish`, and stop there. Do not promote it to production, attach it to a site, roll back anything or use --yes, --force or --force-drop-invalid unless I ask for exactly that in this conversation.

05

Related components

Documentation