Skip to content

Releases: twana-gul/react-railway

Release list

v0.1.2

Choose a tag to compare

@twana-gul twana-gul released this 13 Oct 14:58

Update GitHub links in package.json, bump version. No crucial update.

v0.1.1

Choose a tag to compare

@twana-gul twana-gul released this 05 Oct 14:33

🚀 v0.1.1 — First public release

This is the first public version of React Railway — a step-by-step UI guide component built with React and MUI.


✨ Highlights

•	✨ Core <Railway> component with spotlight backdrop and MUI Popper tooltip.
•	🧠 New context + hook: RailwayProvider and useRailway().
•	startEngine, stopEngine, isRunning, runningId
•	isViewed, isCompleted, setViewed, setCompleted (persisted via localStorage)
•	railwayOrder, setRailwayOrder (single tour runs at a time; ordered autostart)
•	🚦 Autostart per tour via config.autoStart (respects railwayOrder and viewed/completed).
•	🎯 Station targeting:
•	With id: highlights element (data-railway-station="..."), smart scroll-into-view, auto top/bottom placement.
•	Without id: popper centers on the viewport (no backdrop hole).
•	🧰 Utility: clickElement(selector, options) to open drawers/menus, scroll, and wait for UI.
•	📦 Build & types: ESM + CJS outputs, bundled TypeScript declarations, React/MUI as peer deps.

📦 Install via NPM

npm install react-railway

🧪 Tested with

  • React 19+
  • MUI v7+
  • Typescript