New-UDUpload

Upload files

Synopsis

Upload files

Syntax

New-UDUpload [[-Id] <String>] [[-Accept] <String>] [[-OnUpload] <Endpoint>] [[-Text] <String>] [[-Variant] <String>] [[-Color] <String>] [[-ClassName] <String>] [-HideUploadedFileName] [-ShowLoading] [[-LoadingIndicator] <Object>] [[-LoadingPosition] <String>] [[-Icon] <Object>] [[-IconAlignment] <String>] [<CommonParameters>]

Description

Upload files. This component works with UDForm and UDStepper.

Parameters

-Id

The ID of the uploader.

Required?                    false
Position?                    1
Default value                [Guid]::NewGuid()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Accept

The type of files to accept. By default, this component accepts all files.

Required?                    false
Position?                    2
Default value                *
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-OnUpload

A script block to execute when a file is uploaded. This $body parameter will contain JSON in the following format:

    {
        data: 'base64 encoded string of file data',
        name: 'filename',
        type: 'type of file, if known'
    }

    $EventData will contain a class with the following properties:

    public string Name { get; set; }
    public string FileName { get; set; }
    public DateTime TimeStamp { get; set; }
    public string ContentType { get; set; }
    public string Type => ContentType;

Required?                    false
Position?                    3
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Text

The text to display on the upload button.

Required?                    false
Position?                    4
Default value                Upload
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Variant

The variant of button. Defaults to contained. Valid values: "text", "outlined", "contained"

Required?                    false
Position?                    5
Default value                contained
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Color

The color of the button. Defaults to 'default'. Valid values: "default", "primary", "secondary", "inherit"

Required?                    false
Position?                    6
Default value                primary
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ClassName

A CSS class to apply to the button.

Required?                    false
Position?                    7
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -HideUploadedFileName [<SwitchParameter>]
        Hides the file name text that is shown after upload

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -ShowLoading [<SwitchParameter>]
        Displays a loading spinner while the OnClick event handler is running.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-LoadingIndicator A custom element to display instead of the built in spinner for -ShowLoadingRequired? falsePosition? 8Default valueAccept pipeline input? falseAliasesAccept wildcard characters? false-LoadingPositionThe position of the loading indicator. Valid values are: 'start', 'end', 'center'Required? falsePosition? 9Default value centerAccept pipeline input? falseAliasesAccept wildcard characters? false-Icon The icon to show instead of the default icon. Use New-UDIcon to create an icon.Required? falsePosition? 10Default valueAccept pipeline input? falseAliasesAccept wildcard characters? false-IconAlignmentHow to align the icon within the button. Valid values are: "left", "right"Required? falsePosition? 11Default value leftAccept pipeline input? falseAliasesAccept wildcard characters? false <CommonParameters> This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).Outputs-------------------------- EXAMPLE 1 --------------------------PS >New-UDUpload -Text "Upload" -OnUpload {PS > Show-UDToast $BodyPS > } -Id 'upload1'Basic Upload|A basic upload component that shows a toast when a file is uploaded.-------------------------- EXAMPLE 2 --------------------------PS >New-UDUpload -Text "Upload" -OnUpload {PS > Show-UDToast $BodyPS > } -Id 'upload2' -HideUploadedFileNameHide File Name|Hides the file name text that is shown after upload.-------------------------- EXAMPLE 3 --------------------------PS >New-UDUpload -Text "Upload" -OnUpload {PS > Show-UDToast $BodyPS > } -Id 'upload3' -Icon (New-UDIcon -Icon 'Upload')Icon|Upload component with an icon instead of the default icon.-------------------------- EXAMPLE 4 --------------------------PS >New-UDUpload -Text "Upload" -OnUpload {PS > Show-UDToast $BodyPS > } -Id 'upload4' -IconAlignment 'right' -Icon (New-UDIcon -Icon 'Upload')Icon Alignment|Upload component with an icon on the right side of the button.-------------------------- EXAMPLE 5 --------------------------PS >New-UDUpload -Text "Upload" -OnUpload {PS > Show-UDToast $BodyPS > } -Id 'upload5' -Variant 'text'Variant|Upload component with a text variant.-------------------------- EXAMPLE 6 --------------------------PS >New-UDUpload -Text "Upload" -OnUpload {PS > Show-UDToast $BodyPS > } -Id 'upload6' -Accept ".jpg"Accept|Upload component that only accepts .jpg files.