Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/IeuanWalker/Maui.Breadcrumb

This is a breadcrumb navigation control that is complete automatic and uses the Navigation stack and page titles to generate the breadcrumbs. It's also 100% accessible by default..
https://github.com/IeuanWalker/Maui.Breadcrumb

Last synced: 3 months ago
JSON representation

This is a breadcrumb navigation control that is complete automatic and uses the Navigation stack and page titles to generate the breadcrumbs. It's also 100% accessible by default..

Host: GitHub
URL: https://github.com/IeuanWalker/Maui.Breadcrumb
Owner: IeuanWalker
Created: 2022-08-15T18:00:40.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-06-20T11:18:12.000Z (5 months ago)
Last Synced: 2024-07-20T14:43:25.688Z (4 months ago)
Language: C#
Homepage:
Size: 5 MB
Stars: 103
Watchers: 4
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

awesome-dotnet-maui - Breadcrumb - square)](https://github.com/IeuanWalker/Maui.Breadcrumb/stargazers)|[![GitHub last-commit](https://img.shields.io/github/last-commit/IeuanWalker/Maui.Breadcrumb?style=flat-square)](https://github.com/IeuanWalker/Maui.Breadcrumb/commits) (UI)
awesome-maui - Breadcrumb - square)](https://github.com/IeuanWalker/Maui.Breadcrumb/issues) [![GitHub stars](https://img.shields.io/github/stars/IeuanWalker/Maui.Breadcrumb?style=flat-square)](https://github.com/IeuanWalker/Maui.Breadcrumb/stargazers) ![last commit](https://img.shields.io/github/last-commit/IeuanWalker/Maui.Breadcrumb?style=flat-square) - This is a breadcrumb navigation control that is complete automatic and uses the Navigation stack and page titles to generate the breadcrumbs. (UI / Get Started)

README

        | :memo:        | This is a MAUI version of my [Xamarin NuGet](https://github.com/IeuanWalker/Xamarin.Forms.Breadcrumb)      |

|---------------|:------------------------|

# Maui.Breadcrumb [![Nuget](https://img.shields.io/nuget/v/IeuanWalker.Maui.Breadcrumb)](https://www.nuget.org/packages/IeuanWalker.Maui.Breadcrumb) [![Nuget](https://img.shields.io/nuget/dt/IeuanWalker.Maui.Breadcrumb)](https://www.nuget.org/packages/IeuanWalker.Maui.Breadcrumb) 

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FIeuanWalker%2FMaui.Breadcrumb.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FIeuanWalker%2FMaui.Breadcrumb?ref=badge_shield) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8893845ed9bc4f208def01baae7cb6c6)](https://app.codacy.com/gh/IeuanWalker/Maui.Breadcrumb?utm_source=github.com&utm_medium=referral&utm_content=IeuanWalker/Maui.Breadcrumb&utm_campaign=Badge_Grade_Settings)

This is a breadcrumb navigation control that is completely automatic and uses the Navigation stack to get the page titles to generate the breadcrumbs.

The animation for the control is based on this article - [A Cool Breadcrumbs Bar with Xamarin Forms Animations…](https://theconfuzedsourcecode.wordpress.com/2017/02/04/a-cool-breadcrumbs-bar-with-xamarin-forms-animations/)

Basic example             |  Production Example

:-------------------------:|:-------------------------:

![Example gif](/Example.gif)  |  ![Production Example gif](/ProdExample.gif)

## How to use it?

Install the [NuGet package](https://www.nuget.org/packages/IeuanWalker.Maui.Breadcrumb/) into all of your projects 

```

Install-Package IeuanWalker.Maui.Breadcrumb

```

This control uses one of my other controls, [StateButton](https://github.com/IeuanWalker/Maui.StateButton), this is to make this control accessible. Ao you'll need to register the using in the `MauiProgram.cs` on the `MauiAppBuilder`

```csharp

builder

	.UseMauiApp()

	.UseStateButton();

```

To add to a page the first thing we need to do is tell our XAML page where it can find the Breadcrumb control, which is done by adding the following attribute to our ContentPage:

```xml

    

        ...

    

```

Next up, just add the breadcrumb control onto that page and you're all set.

```xml

```

## What can I do with it?

| Property | What it does | Extra info |

|---|---|---- |

| Separator | Sets the image source of the separator | This allows you to set the separator to `FontImageSource`, `UriImageSource` or `FileImageSource`.  Default is **new FontImageSource { Glyph = " / ", Color = Colors.Black, Size = 15, }** |

| SeparatorHeight | Sets the height of the separator | Default is **15** |

| FirstBreadcrumb | Allows you to override the first breadcrumb and set an image source. F.e. This is usefull if you want the first breadcrumb to be a home icon instead of the default title. | Default will be a label like all the other breadcrumbs |

| ScrollBarVisibility | Sets the HorizontalScrollBarVisibility of the scrollview | More info here [ScrollBarVisibility](https://docs.microsoft.com/en-us/dotnet/api/xamarin.forms.scrollbarvisibility?view=xamarin-forms). Default value is **ScrollBarVisibility.Never** |

| FontSize | Sets the text font size for the breadcrumb | Default value is **15**. 
Support [`NamedSize`](https://docs.microsoft.com/en-us/dotnet/api/xamarin.forms.namedsize?view=xamarin-forms) |

| TextColor | Sets the text color for the breadcrumb and seperator   | A `Color` object. 
 Default value is **black**. 
*(doesnt include the last breadcrumb)* |

| CornerRadius | A `CornerRadius` object representing each individual corner's radius for each breadcrumb. | Uses the `CornerRadius` struct allowing you to specify individual corners. 
 Default value is **10**. 
 *(doesnt include the last breadcrumb)* |

| BreadcrumbMargin | A `Thickness` object used to define the spacing between the breadcrumb and separators | Uses the `Thickness` struct allowing you to specify left, top, right and bottom margin |

| BreadcrumbBackgroundColor | This is the background color for the individual breadcrumbs | A `Color` object. 
 Default value is **Transparent**. 
 *(doesnt include the last breadcrumb)* |

| LastBreadcrumbTextColor | Sets the text color for the last breadcrumb | A Color object. 
 Default value is **black**. |

| LastBreadcrumbCornerRadius | A `CornerRadius` object representing each individual corner's radius.| Uses the `CornerRadius` struct allowing you to specify individual corners. 
 Default value is **10**. |

| LastBreadcrumbBackgroundColor | Sets the background color of the last breadcrumbs |  A Color object. 
 Default value is **Transparent**. |

| AnimationSpeed | Sets the speed of the animated breadcrumb | Default value is **800**. 
 Set to 0 to disable the animation. |

| IsNavigationEnabled | Used to remove the tab gesture from breadcrumbs | Default value is **True**|

### First breadcrumb customization

You are able to change the first breadcrumb to an Icon, embedded image or url image.

```xml

    

        

    

```

### Separator customization 

You are able to change the separators to an Icon, embedded image or url image.

Font - (FontAwesome)

```xml

    

        

    

```

Image - URL

```xml

    

        

    

```

Image - Embedded

```xml

    

        

    

```

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FIeuanWalker%2FMaui.Breadcrumb.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FIeuanWalker%2FMaui.Breadcrumb?ref=badge_large)