# Edge

> Shared directional highlights for your existing UI.

Documentation target: @bolerish/edge 0.4.0. Check the installed package version and declarations before applying these examples.

React prepares styles automatically; for SSR render Edge.Styles once per document before application styles, with the request nonce when CSP requires it. React 18 and 19 are supported. Other framework adapters are not available yet. The library defaults to motion="system"; interactive examples use the documentation site’s preferences.

## Documentation

- [Getting started · Introduction](https://edge.bolerish.com/docs/index.md): Subtle highlights for your UI, with your existing colors, layout and interactions.

- [Getting started · Installation](https://edge.bolerish.com/docs/installation/index.md): Install Edge and start using it in React.

- [Getting started · Usage](https://edge.bolerish.com/docs/usage/index.md): Understand lights and surfaces before connecting your components.

- [React · Usage](https://edge.bolerish.com/docs/react/usage/index.md): Start with Edge.Provider and Edge.Surface. Use useSurface to connect an existing component directly.

- [React · Edge.Provider](https://edge.bolerish.com/docs/react/provider/index.md): Creates a shared light for descendant surfaces.

- [React · Edge.Surface](https://edge.bolerish.com/docs/react/surface/index.md): Applies lighting to a DOM element.

- [React · useLight](https://edge.bolerish.com/docs/react/use-light/index.md): Creates and configures a light handle.

- [React · useSurface](https://edge.bolerish.com/docs/react/use-surface/index.md): Returns a ref that connects an existing DOM element to a light.

- [Styles · Style](https://edge.bolerish.com/docs/styles/index.md): Choose how a surface responds to light without changing its base styles.

- [Styles · Motion](https://edge.bolerish.com/docs/motion/index.md): Choose whether a shared light follows the pointer or keeps a fixed direction.

- [Guides · Integration considerations](https://edge.bolerish.com/docs/integration/index.md): Handle decoration conflicts, native inputs and layout changes.

- [Guides · AI Integration](https://edge.bolerish.com/docs/ai-integration/index.md): Give your assistant current Edge documentation before it changes your UI.

## Complete documentation

- [All documents](https://edge.bolerish.com/llms-full.txt): Full text of the pages above.