| 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.
|
2632 |
| BetaLabel.kt |
Beta label.
@param modifier The modifier to apply to this layout.
|
2277 |
| 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 cornerRadius The corner radius of the handle.
@param color Color of the handle.
|
2829 |
| button |
|
|
| 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.
|
3601 |
| 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 |
| core |
|
|
| DismissibleItemBackground.kt |
The background of an item that is being swiped horizontally.
@param isSwipeActive Whether the swipe gesture is active.
@param isSwipingToStart Whether the swipe gesture is in the start direction.
@param modifier [Modifier] to apply to the background.
@param shape Shape of the background.
|
3641 |
| 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.
@param shape The shape used to clip the favicon. Defaults to a slightly rounded rectangle.
Use [CircleShape] for a round image.
|
4342 |
| 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.
|
4331 |
| 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].
|
3790 |
| 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 |
| InfoCard.kt |
Card for presenting informational messages or errors.
@param modifier Modifier to be applied to the card.
@param title The primary text of the info message.
@param type The [InfoType] of message to display.
@param verticalRowAlignment An optional adjustment of how the row of text aligns.
@param description The optional secondary piece of text.
@param footer An optional piece of text with a clickable link.
@param buttonText The text to show in the optional button.
|
9011 |
| InfoCardContainer.kt |
A card container for informative or error messages that can be expanded and collapsed.
@param title The title of the card.
@param isExpanded Whether or not the card is expanded.
@param modifier Modifier to be applied to the card.
@param onExpandToggleClick Invoked when the card is expanded or collapsed.
@param content The content of the card.
|
6784 |
| 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.
|
10443 |
| list |
|
|
| ListItemTabSurface.kt |
Shared default configuration of a ListItemTabLarge Composable.
@param imageUrl URL from where the to download a header image of the tab this composable renders.
@param imageContentScale Optional scale parameter used to determine the aspect ratio scaling to
be used on the image.
@param backgroundColor Background [Color] of the item.
@param contentPadding Padding used for the image and details of the item.
@param onClick Optional callback to be invoked when this composable is clicked.
@param tabDetails [Composable] Displayed to the the end of the image. Allows for variation in the item text style.
|
4708 |
| 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 modifier Modifier to be applied to the menu.
@param canShowCheckItems Whether the user can check items on the dropdown menu.
@param offset Offset to be added to the position of the menu.
@param onDismissRequest Invoked when user dismisses the menu or on orientation changes.
|
8684 |
| MessageCard.kt |
State-based Message Card.
@param messageCardState State representing the card.
@param modifier Modifier to be applied to the card.
@param onClick Invoked when user clicks on the message card.
@param onCloseButtonClick Invoked when user clicks on close button to remove message.
|
12390 |
| 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].
|
5207 |
| PlaceholderCard.kt |
Card for presenting placeholder information or CTAs.
@param title Composable for the title slot in the component.
@param description Composable for the description slot in the component.
@param modifier Modifier to apply to the card.
|
5131 |
| snackbar |
|
|
| String.kt |
Method used to transform HTML strings containing bold style to [AnnotatedString] to be used inside composables.
|
1183 |
| SwipeToDismissBox2.kt |
The distance an item has to be swiped before it is considered dismissed.
|
13752 |
| 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 checked Whether or not the switch is checked.
@param modifier Modifier to be applied to the switch layout.
@param description An optional description text below the label.
@param enabled Whether the switch is enabled or grayed out.
@param labelStyle The style to be applied to the label text.
@param onCheckedChange Invoked when Switch is being clicked, therefore the change of checked
state is requested.
|
7804 |
| 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.
|
4175 |
| 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 shape [Shape] to be applied to the thumbnail card.
@param backgroundColor [Color] used for the background of the favicon.
@param border [BorderStroke] to be applied around the thumbnail card.
@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.
|
4067 |
| 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.
|
3743 |
| 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.
|
4433 |
| utils |
|
|