Particle.Maui 1.0.3

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package Particle.Maui --version 1.0.3
                    


                    

                
NuGet\Install-Package Particle.Maui -Version 1.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Particle.Maui" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Particle.Maui" Version="1.0.3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Particle.Maui" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Particle.Maui --version 1.0.3
                    


                    

                
#r "nuget: Particle.Maui, 1.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Particle.Maui@1.0.3
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Particle.Maui&version=1.0.3
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Particle.Maui&version=1.0.3
                    


                            Install as a Cake Tool

Particles.Maui

A MAUI library to display particles e.g. confetti. Should work on all platforms. Ported from the Xamarin Forms version of this library: https://github.com/mariusmuntean/Particle.Forms

Get it from NuGet Nuget

Preview

<img src="Media/sample.gif" width="640px" />

API Reference

The starting point is the class ParticleView.

| BindableProperty | Default | Description | |------------------|---------|-------------| | IsActive | true | Whether or not the control is displaying particles. Use this property to stop and restart the particles. | | IsRunning | true | Whether or not the control is animating particles. Use this property to pause and resume the particles. | | HasFallingParticles | false | Whether or not falling particles should be shown. | | FallingParticlesPerSecond | 60 | Amount of new particles to be added every second when HasFallingParticles is true. | | AddParticlesOnTap | false | Whether or not to add particles on tap. | | TapParticleCount | 30 | Amount of particles to add on tap when AddParticlesOnTap is true. | | AddParticlesOnDrag | false | Whether or not to add particles on drag. | | DragParticleCount | 60 | Amount of particles to add on drag when AddParticlesOnDrag is true. | | DragParticleMoveType | ParticleMovetype.Fall | Particle movement type while dragging. | | UseSKGLView | False on all platforms except Android | Whether or not to use the hardware-accelerated view for drawing. | | ShowDebugInfo | False | Whether or not to show debug information. | | DebugInfoColor | LawnGreen | Color to use when displaying debug information. | <br>

These properties aren't bindable.

| Property | Default | Description | |------------------|-|---------| | TouchParticleGenerator | SimpleParticleGenerator | A ParticleBase generator to be used when interacting with the ParticleView | | FallingParticleGenerator | FallingParticleGenerator | A ParticleBase generator to be used when showing particles that fall from the top edge to the bottom | | CanvasSize | <none>| Contains the current canvas size | <br>

Usage Sample

<?xml version="1.0" encoding="utf-8"?>

<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:particle="clr-namespace:Particle.Maui;assembly=Particle.Maui"
             x:Class="Particle.Maui.Sample.Demo2.Demo2"
             Title="Custom Particles">
    <ContentPage.Resources>
        <x:Array Type="{x:Type Color}" x:Key="ConfettiColors">
            <Color>#a864fd</Color>
            <Color>#29cdff</Color>
            <Color>#78ff44</Color>
            <Color>#ff718d</Color>
            <Color>#fdff6a</Color>
            <Color>#ffcbf2</Color>
        </x:Array>
    </ContentPage.Resources>

    <Grid VerticalOptions="FillAndExpand"
          BackgroundColor="White"
          Margin="0 ,0, 0, 5">


        <particle:ParticleView x:Name="MyParticleCanvas"
                            IsActive="True"
                            IsRunning="True"
                            HasFallingParticles="True"
                            FallingParticlesPerSecond="20"
                            Margin="0, 20"
                            VerticalOptions="FillAndExpand"
                            HorizontalOptions="FillAndExpand"
                            ParticleColors="{StaticResource ConfettiColors}" />
    </Grid>
</ContentPage>

Tip

To conserver resources you can pause the particles when the Page is about to disappear and resume when the Page is about to appear.

        protected override void OnAppearing()
        {
            base.OnAppearing();

            MyParticleCanvas.IsRunning = true;
        }

        protected override void OnDisappearing()
        {
            base.OnDisappearing();

            MyParticleCanvas.IsRunning = false;
        }
Product Compatible and additional computed target framework versions.
.NET net6.0-android31.0 is compatible.  net6.0-ios16.0 is compatible.  net6.0-maccatalyst15.4 is compatible.  net6.0-windows10.0.19041 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-windows was computed.  net8.0-android was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-windows was computed.  net9.0-android was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-windows was computed.  net10.0-android was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.3 5,885 10/14/2022
1.0.2 527 10/14/2022
1.0.1 527 10/14/2022
1.0.0 530 10/14/2022

See the API reference: https://github.com/jbowmanp1107/Particle.Maui#api-reference