| annotation |
|
|
| Banner.kt |
Default layout for a Banner messaging surface with two text buttons.
@param message The primary text displayed to the user.
@param button1Text The text of the first button.
@param button2Text The text of the second button.
@param onButton1Click Invoked when the first button is clicked.
@param onButton2Click Invoked when the second button is clicked.
|
2626 |
| BetaLabel.kt |
Beta label.
@param modifier The modifier to apply to this layout.
|
2251 |
| BottomSheetHandle.kt |
A handle present on top of a bottom sheet. This is selectable when talkback is enabled.
@param onRequestDismiss Invoked on clicking the handle when talkback is enabled.
@param contentDescription Content Description of the composable.
@param modifier The modifier to be applied to the Composable.
@param color Color of the handle.
|
2520 |
| button |
|
|
| Chip.kt |
Default layout for a clickable chip.
@param text [String] displayed in this chip.
@param modifier [Modifier] used to be applied to the layout of the chip.
@param isSquare Optional [Boolean] to control whether the Chip's corners are square or rounded.
@param backgroundColor Optional background [Color] for the chip.
@param textColor Optional text [Color] for the chip.
@param onClick Callback for when the user taps this chip.
|
7505 |
| ClickableSubstringLink.kt |
[Text] containing a substring styled as an URL informing when this is clicked.
@param text Full text that will be displayed.
@param textStyle The [TextStyle] to apply to the text.
@param textColor [Color] of the normal text. The URL substring will have a default URL style applied.
@param linkTextColor [Color] of the link text.
@param linkTextDecoration The decorations to paint on the link text (e.g., an underline).
@param clickableStartIndex [text] index at which the URL substring starts.
@param clickableEndIndex [text] index at which the URL substring ends.
@param onClick Callback to be invoked only when the URL substring is clicked.
|
3515 |
| ComposeUtils.kt |
Indicates whether the app is currently running in a Composable @Preview.
|
511 |
| ComposeViewHolder.kt |
[RecyclerView.ViewHolder] used for Jetpack Compose UI content .
@property composeView [ComposeView] which will be populated with Jetpack Compose UI content.
@param viewLifecycleOwner [LifecycleOwner] life cycle owner for the view.
|
1775 |
| Divider.kt |
Generic divider.
@param modifier [Modifier] used to be applied to the layout of the divider.
|
2873 |
| ext |
|
|
| Favicon.kt |
Load and display the favicon of a particular website.
@param url Website URL for which the favicon will be shown.
@param size [Dp] height and width of the image to be loaded.
@param modifier [Modifier] to be applied to the layout.
@param isPrivate Whether or not a private request (like in private browsing) should be used to
download the icon (if needed).
@param imageUrl Optional image URL to create an [IconRequest.Resource] from.
|
3950 |
| home |
|
|
| HorizontalFadingEdgeBox.kt |
Displays the [content] with the right edge fading.
@param modifier [Modifier] for the container.
@param fadeWidth Length of the fading edge.
@param backgroundColor [Color] of the background shown under the content.
@param isContentRtl Whether or not the content should be displayed Right to Left
@param content The content whose right edge must be faded.
|
4329 |
| Image.kt |
A composable that lays out and draws the image from a given URL while showing a default placeholder
while that image is downloaded or a default fallback image when downloading failed.
@param url URL from where the to download the image to be shown.
@param modifier [Modifier] to be applied to the layout.
@param private Whether or not this is a private request. Like in private browsing mode,
private requests will not cache anything on disk and not send any cookies shared with the browser.
@param targetSize Image size (width and height) the loaded image should be scaled to.
@param contentDescription Localized text used by accessibility services to describe what this image represents.
This should always be provided unless this image is used for decorative purposes, and does not represent
a meaningful action that a user can take.
@param alignment Optional alignment parameter used to place the [Painter] in the given
bounds defined by the width and height.
@param contentScale Optional scale parameter used to determine the aspect ratio scaling to be used
if the bounds are a different size from the intrinsic size of the [Painter].
@param placeholder composable displayed while the image is still loading.
By default set to a solid color in [DefaultImagePlaceholder].
@param fallback composable displayed when the image fails loading.
By default set to a solid color in [DefaultImagePlaceholder].
|
3728 |
| ImagesPlaceholder.kt |
Renders the app image placeholder while the image is still getting loaded.
@param placeholder [Composable] composable used during loading.
By default, set to [DefaultImagePlaceholder] in [org.mozilla.fenix.compose.Image].
|
2559 |
| LazyListEagerFlingBehavior.kt |
[FlingBehavior] for a [LazyRow] that will automatically scroll the list in the fling direction
to fully show the next item.
|
1652 |
| LinkText.kt |
The tag used for links in the text for annotated strings.
|
10660 |
| list |
|
|
| ListItemTabLarge.kt |
Default layout of a large tab shown in a list taking String arguments for title and caption.
Has the following structure:
```
---------------------------------------------
| -------------- Title |
| | Image | wrapped on |
| | from | three rows if needed |
| | imageUrl | |
| -------------- Optional caption |
---------------------------------------------
```
@param imageUrl URL from where the to download a header image of the tab this composable renders.
@param title Title off the tab this composable renders.
@param caption Optional caption text.
@param backgroundColor Background [Color] of the item.
@param onClick Optional callback to be invoked when this composable is clicked.
|
7369 |
| ListItemTabLargePlaceholder.kt |
Placeholder of a [ListItemTabLarge] with the same dimensions but only a centered text.
Has the following structure:
```
---------------------------------------------
| |
| |
| Placeholder text |
| |
| |
---------------------------------------------
```
@param text The only [String] that this will display.
@param backgroundColor The background [Color] of the list item placeholder.
@param onClick Optional callback to be invoked when this composable is clicked.
|
2920 |
| LongPressIconButton.kt |
An [IconButton] that supports a long press gesture.
|
2119 |
| Menu.kt |
Root popup action dropdown menu.
@param menuItems List of items to be displayed in the menu.
@param showMenu Whether or not the menu is currently displayed to the user.
@param cornerShape Shape to apply to the corners of the dropdown.
@param onDismissRequest Invoked when user dismisses the menu or on orientation changes.
@param modifier Modifier to be applied to the menu.
@param offset Offset to be added to the position of the menu.
|
7139 |
| MessageCard.kt |
Message Card.
@param messageText The message card's body text to be displayed.
@param titleText An optional title of message card. If the provided title text is blank or null,
the title will not be shown.
@param buttonText An optional button text of the message card. If the provided button text is blank or null,
the button won't be shown.
@param messageColors The color set defined by [MessageCardColors] used to style the message card.
@param onClick Invoked when user clicks on the message card.
@param onCloseButtonClick Invoked when user clicks on close button to remove message.
|
8906 |
| PagerIndicator.kt |
An horizontally laid out indicator for a [HorizontalPager] with the ability to leave the trail of
indicators to show progress, instead of just showing the current one as active.
@param pagerState The state object of your [HorizontalPager] to be used to observe the list's state.
@param modifier The modifier to apply to this layout.
@param activeColor The color of the active page indicator, and the color of previous page
indicators in case [leaveTrail] is set to true.
@param inactiveColor The color of page indicators that are inactive.
@param leaveTrail Whether to leave the trail of indicators to show progress.
This defaults to false and just shows the current one as active.
@param spacing The spacing between each pager indicator in [Dp].
|
5315 |
| StaggeredHorizontalGrid.kt |
Displays a list of items as a staggered horizontal grid placing them on ltr rows and continuing
on as many below rows as needed to place all items.
In an effort to best utilize the available row space this can mix the items such that narrower ones
are placed on the same row as wider ones if the otherwise next item doesn't fit.
@param modifier [Modifier] to be applied to the layout.
@param horizontalItemsSpacing Minimum horizontal space between items. Does not add spacing to layout bounds.
@param verticalItemsSpacing Vertical space between items
@param arrangement How the items will be horizontally aligned and spaced.
@param content The children composables to be laid out.
|
5804 |
| String.kt |
Method used to transform HTML strings containing bold style to [AnnotatedString] to be used inside composables.
|
1183 |
| SwipeToDismiss.kt |
A composable that can be dismissed by swiping left or right
@param state The state of this component.
@param modifier Optional [Modifier] for this component.
@param enabled [Boolean] controlling whether the content is swipeable or not.
@param directions The set of directions in which the component can be dismissed.
@param dismissThreshold The threshold the item needs to be swiped in order to be dismissed.
@param backgroundContent A composable that is stacked behind the primary content and is exposed
when the content is swiped. You can/should use the [state] to have different backgrounds on each side.
@param dismissContent The content that can be dismissed.
|
6297 |
| SwitchWithLabel.kt |
UI for a switch with label that can be on or off.
@param label Text to be displayed next to the switch.
@param description An optional description text below the label.
@param checked Whether or not the switch is checked.
@param onCheckedChange Invoked when Switch is being clicked, therefore the change of checked
state is requested.
@param modifier Modifier to be applied to the switch layout.
@param enabled Whether the switch is enabled or grayed out.
|
7212 |
| TabCounter.kt |
UI for displaying the number of opened tabs.
This composable uses LocalContentColor, provided by CompositionLocalProvider,
to set the color of its icons and text.
@param tabCount the number to be displayed inside the counter.
|
4906 |
| tabstray |
|
|
| TabSubtitleWithInterdot.kt |
Special caption text for a tab layout shown on one line.
This will combine [firstText] with a interdot and then [secondText] ensuring that the second text
(which is assumed to be smaller) always fills as much space as needed with the [firstText] automatically
being resized to be smaller with an added ellipsis characters if needed.
Possible results:
```
- when both texts would fit the screen
------------------------------------------
|firstText · secondText |
------------------------------------------
- when both text do not fit, second is shown in entirety, first is ellipsised.
------------------------------------------
|longerFirstTextOrSmallSc... · secondText|
------------------------------------------
```
@param firstText Text shown at the start of the row.
@param secondText Text shown at the end of the row.
|
4174 |
| TabThumbnail.kt |
Thumbnail belonging to a [tab]. If a thumbnail is not available, the favicon
will be displayed until the thumbnail is loaded.
@param tab The given [TabSessionState] to render a thumbnail for.
@param size Size of the thumbnail.
@param modifier [Modifier] used to draw the image content.
@param backgroundColor [Color] used for the background of the favicon.
@param contentDescription Text used by accessibility services
to describe what this image represents.
@param contentScale [ContentScale] used to draw image content.
@param alignment [Alignment] used to draw the image content.
|
3636 |
| ThumbnailCard.kt |
Card which will display a thumbnail. If a thumbnail is not available for [url], the favicon
will be displayed until the thumbnail is loaded.
@param url Url to display thumbnail for.
@param request [ImageLoadRequest] used to fetch the thumbnail bitmap.
@param modifier [Modifier] used to draw the image content.
@param backgroundColor [Color] used for the background of the favicon.
@param contentDescription Text used by accessibility services
to describe what this image represents.
@param contentScale [ContentScale] used to draw image content.
@param alignment [Alignment] used to draw the image content.
|
3698 |
| ThumbnailImage.kt |
Thumbnail belonging to a [ImageLoadRequest]. Asynchronously fetches the bitmap from storage.
@param request [ImageLoadRequest] used to fetch the thumbnail bitmap.
@param contentScale [ContentScale] used to draw image content.
@param alignment [Alignment] used to draw the image content.
@param modifier [Modifier] used to draw the image content.
@param fallbackContent The content to display with a thumbnail is unable to be loaded.
|
4240 |