feat: the guided tour library - #1

Merged

eumaninho54 merged 80 commits into

mainfrom

feat/guided-tour

Aug 27, 2026

Commits on Aug 27, 2026

chore: point the package at the Salve-Software org
eumaninho54
committed
d18fd86
fix(jest): render the unresolved source-condition template
eumaninho54
committed
abedb1a
build: replace lefthook with husky and lint-staged
eumaninho54
committed
8d837e5
style: move prettier config out of package.json
eumaninho54
committed
249e0e6
build: resolve the @/ alias across babel, tsc and jest
eumaninho54
committed
b1678eb
ci(eslint): ban relative parent imports and widen the glob
eumaninho54
committed
785b2cc
ci: check formatting in the pipeline
eumaninho54
committed
e710c88
chore: ignore the example web build output
eumaninho54
committed
8fe3960
build(deps): take reanimated as the only peer dependency
eumaninho54
committed
a5f73b5
feat(types): declare the public tour API
eumaninho54
committed
17b5580
feat(constants): port the palette and geometry from the prototype
eumaninho54
committed
188c491
feat(utils): resolve tour geometry, placement and scrolling
eumaninho54
committed
ad44390
feat(storage): persist which tours were already seen
eumaninho54
committed
d8fcf3e
feat(spotlight): dim the screen and cut the hole over the target
eumaninho54
committed
0f8958e
feat(card): render the default tour card
eumaninho54
committed
e0ee0e5
feat(target): register targets and reach the ones below the fold
eumaninho54
committed
5e4c92d
feat(provider): drive tour state and step measurement
eumaninho54
committed
fed2685
feat: expose the Cicerone namespace as the public entry point
eumaninho54
committed
559187f
build(example): add reanimated and safe-area to the demo
eumaninho54
committed
e520295
build(example): alias the demo sources as ~/
eumaninho54
committed
29a2a25
feat(example): demo static, scrolled and highlight steps
eumaninho54
committed
55e66d9
docs: document the tour API in the readme
eumaninho54
committed
127f68d
docs: add project rules for AI agents
eumaninho54
committed
1442c6b
style: apply prettier to the scaffold files
eumaninho54
committed
71d14ff
chore: update the lockfile
eumaninho54
committed
68b93e6
fix(example): resolve the aliases through Metro instead of babel
eumaninho54
committed
eebc79b
docs: record the Metro alias resolution gotcha
eumaninho54
committed
72cf42e
fix(deps): pin reanimated and worklets to the SDK versions
eumaninho54
committed
0bf8332
docs: warn against copying dependency versions
eumaninho54
committed
9da2732
fix(card): slide the card to its new position between steps
eumaninho54
committed
63d01eb
perf(spotlight): cut the per-frame work of a step transition
eumaninho54
committed
9484472
fix(card): stop stretching the card when it sits above the target
eumaninho54
committed
7402d6c
feat: fade the overlay out when the tour ends
eumaninho54
committed
f006ca8
fix: stop restarting animations on every render
eumaninho54
committed
fc914a9
docs: warn about easings rebuilt every render
eumaninho54
committed
952b89b
fix(spotlight): cover the screen corners, not just the edges
eumaninho54
committed
bebdbfa
build(deps): take react-native-svg as a peer dependency
eumaninho54
committed
9ce7f20
perf(spotlight): draw the scrim as an even-odd SVG path
eumaninho54
committed
63ea22c
fix(card): stop restarting the slide when the card re-measures
eumaninho54
committed
b274fb9
fix(card): stop fading the card out on every step
eumaninho54
committed
6d69bf0
chore: ignore the example native projects
eumaninho54
committed
81b342b
refactor(types): give every hook prop type its own file
eumaninho54
committed
753b233
docs: drop the last comments that restate the code
eumaninho54
committed
a657605
refactor(providers): move CiceroneProvider out of components
eumaninho54
committed
8740e76
docs: record where providers live
eumaninho54
committed
9c96d90
refactor: rename the entry point to .ts
eumaninho54
committed
2701545
chore: publish under the @salve-software scope
eumaninho54
committed
d3c32e0
docs: use the scoped package name
eumaninho54
committed
80233f2
fix(types): let a theme override carry a partial palette
eumaninho54
committed
4646032
build(example): add Storybook on device
eumaninho54
committed
8331249
feat(example): browse the tour through Storybook
eumaninho54
committed
2ee7128
build(example): register the datetimepicker config plugin
eumaninho54
committed
a7e892b
fix(example): keep the demo inside its provider
eumaninho54
committed
033bb4d
test(hooks): cover useCicerone outside a provider
eumaninho54
committed
2f1052a
fix(test): drop the unused React import
eumaninho54
committed
51b25f0
fix(example): make the story stage usable
eumaninho54
committed
4fa6628
docs: warn that a Target takes part in layout
eumaninho54
committed
26f0772
feat(utils): translate geometry into the overlay's own box
eumaninho54
committed
00648c7
fix(overlay): stop assuming the provider sits at the window origin
eumaninho54
committed
df52351
fix(card): measure the card against the overlay box too
eumaninho54
committed
7ea3166
docs: add the pull request template CONTRIBUTING already pointed at
eumaninho54
committed
cc944c1
chore: start from 0.0.0 so the first release lands on 0.1.0
eumaninho54
committed
01f68e0
docs: cut the readme down to the essentials
eumaninho54
committed
6d2c53f
build: keep the docs site out of the library's toolchain
eumaninho54
committed
e95b26b
docs: add the documentation site
eumaninho54
committed
92c935f
ci: deploy the docs site to GitHub Pages
eumaninho54
committed
d498c11
docs: rewrite the copy in plainer language
eumaninho54
committed
18f1d1e
docs: put the banner at the top of the readme
eumaninho54
committed
cc0cbc9
feat(website): wire up i18n with a locale switch
eumaninho54
committed
e5bbef3
docs(website): translate the site to pt-BR
eumaninho54
committed
8474041
feat(website): use the real logo and icons
eumaninho54
committed
0c32c6a
style: drop the trailing dot from the wordmark
eumaninho54
committed
f0e0327
refactor(example): make the demo generic

eumaninho54
and
claude
committed
6c517d8
docs(example): rewrite the story copy

eumaninho54
and
claude
committed
737935d
docs: drop the product name from constants

eumaninho54
and
claude
committed
688415c
style(example): extract the custom card styles

eumaninho54
and
claude
committed
810b335
fix(example): respect the top safe area

eumaninho54
and
claude
committed
62f39de
docs: add the tour recording to the readme

eumaninho54
and
claude
committed
4451e98
feat(website): add the demo video section

eumaninho54
and
claude
committed
ddd8a05
fix(ci): track the generated storybook file

eumaninho54
and
claude
committed
9e5771a