RouterProps — Kuito Documentation

Usage

Give a tab a title and platform icon

This type is used by Router

tsx

import { Route, Router, Tab, Tabs, Text } from 'kuito';

function Discover() {
  return <Text padding={16}>Discover</Text>;
}

function Library() {
  return <Text padding={16}>Library</Text>;
}

export default function App() {
  return (
    <Router>
      <Tabs>
        <Tab name="discover" title="Discover" icon={{ ios: 'safari', android: 'explore' }}>
          <Route name="index" path="/" screen={Discover} title="Discover" />
        </Tab>
        <Tab
          name="library"
          title="Library"
          icon={{ ios: 'books.vertical', android: 'library_music' }}
        >
          <Route name="library" path="/library" screen={Library} title="Library" />
        </Tab>
      </Tabs>
    </Router>
  );
}

Type declaration

export interface RouterProps {
  /** The first screen shown; the first route's by default. */
  initial?: Destination;
  /**
   * Deep links: the link that launched the app, and each one that arrives
   * while it runs, navigate to the route their path matches. Off by default.
   */
  linking?: boolean;
  children: KuitoNode;
}

Members 3

Name	Type	Required	Description
`initial`	`Destination<unknown>`	No	The first screen shown; the first route's by default.
`linking`	`boolean`	No	Deep links: the link that launched the app, and each one that arrives while it runs, navigate to the route their path matches. Off by default.
`children`	`KuitoNode`	Yes	—

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.