Info

NebkitProvider

core

Global provider for integrating NebulaKit into your app.

<NebkitProvider theme="dark" brand="blue" radius="0px">  <App /></NebkitProvider>

Description


NebkitProvider wraps your whole application to make sure every component in the library renders correctly.

Functionality


  • initializes properties like theme and brand as global defaults for its wrapped subtree

  • can lock global page scroll via the lockGlobalScroll prop, the freed scrollbar width is not compensated, so content that fills the page width can shift by it

  • avoids a flash of unstyled content while server-rendered markup is hydrating

Guidelines


  • typical usage is to wrap the whole app tree with a single instance and render NebulaKit components anywhere inside it

  • multiple instances on independently rendered pages are fine, for example separate pages of a multi-page app each mounting their own instance

  • not meant to be nested

Reuses


Props


brandchildrenlockGlobalScrollradiusripplestroketheme