-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
Copy pathdbcNav.Rd
69 lines (47 loc) · 2.83 KB
/
dbcNav.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
% Auto-generated: do not edit by hand
\name{dbcNav}
\alias{dbcNav}
\title{Nav component}
\description{
Nav can be used to group together a collection of navigation links.
}
\usage{
dbcNav(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, pills=NULL, card=NULL, fill=NULL,
justified=NULL, vertical=NULL, horizontal=NULL, navbar=NULL,
navbar_scroll=NULL, loading_state=NULL)
}
\arguments{
\item{children}{A list of or a singular dash component, string or number. The children of this component}
\item{id}{Character. The ID of this component, used to identify dash components
in callbacks. The ID needs to be unique across all of the
components in an app.}
\item{style}{Named list. Defines CSS styles which will override styles previously set.}
\item{class_name}{Character. Often used with CSS to style elements with common properties.}
\item{className}{Character. **DEPRECATED** Use `class_name` instead.
Often used with CSS to style elements with common properties.}
\item{key}{Character. A unique identifier for the component, used to improve
performance by React.js while rendering components
See https://reactjs.org/docs/lists-and-keys.html for more info}
\item{pills}{Logical. Apply pill styling to nav items. Active items will be indicated by a pill.}
\item{card}{Logical. Set to True when using Nav with pills styling inside a CardHeader.}
\item{fill}{Logical. Expand the nav items to fill available horizontal space.}
\item{justified}{Logical. Expand the nav items to fill available horizontal space, making sure
every nav item has the same width.}
\item{vertical}{Logical | character. Stack NavItems vertically. Set to True for a vertical Nav on all screen
sizes, or pass one of the Bootstrap breakpoints ('xs', 'sm', 'md', 'lg',
'xl') for a Nav which is vertical at that breakpoint and above, and
horizontal on smaller screens.}
\item{horizontal}{A value equal to: 'start', 'center', 'end', 'between', 'around'. Specify the horizontal alignment of the NavItems. Options are 'start',
'center', or 'end'.}
\item{navbar}{Logical. Set to True if using Nav in Navbar component. This applies the `navbar-nav`
class to the Nav which uses more lightweight styles to match the parent
Navbar better.}
\item{navbar_scroll}{Logical. Enable vertical scrolling within the toggleable contents of a collapsed Navbar.}
\item{loading_state}{Lists containing elements 'is_loading', 'prop_name', 'component_name'.
those elements have the following types:
- is_loading (logical; optional): determines if the component is loading or not
- prop_name (character; optional): holds which property is loading
- component_name (character; optional): holds the name of the component that is loading. Object that holds the loading state object coming from dash-renderer}
}
\value{named list of JSON elements corresponding to React.js properties and their values}