Can Custom Action Buttons run javascript in handler? Sharepoint add-in

Question

I created a Custom Action Ribbon button for sharepoint online and i want to run a javascript code when the button is clicked.

Sharepoint documentation even provides an example of it: https://learn.microsoft.com/en-us/sharepoint/dev/schema/commanduihandler-element?redirectedfrom=MSDN#example

but when i'm trying it always returns an error Custom action urls must start with "http:", "https:", "~appWebUrl" or "~remoteAppUrl".

Another part of the documentation says that it is not possible https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-add-ins-ux-design-guidelines?redirectedfrom=MSDN#figure-4-a-custom-action-in-the-contextual-menu

So how do i make it work? is not possible anymore and only can do redirections? or it deppends of the location? i have it defined as <CommandUIDefinition Location="Ribbon.Documents.Actions.Controls._children"> so it is displayed in the command bar.

score 0 · Accepted Answer · answered Feb 17 '21 at 18:33

is it possible? ... I suppose no

Unfortunately it is not possible to add a custom ribbon action with a javascript logic with a provider hosted add-in . I think the articles/links where you found it is possible refer to the Server ribbon xml custom action that could be modified using sandbox solutions (like the old school SharePoint days ), but now the sandbox is rather not supported in SP online.

For the Ribbon custom actions that are added with the add-in you should specify the direct link. This is already what needs to be specified when we add a Ribbon action in VS to the Add-in project (we should specify were we navigate to)

I also found this MSDN article (quite up to date - from 2020) where we may find:

CustomAction cannot contain JavaScript: Any UrlActions or CommandActions must be a URL to navigate to. (...)

So I am like 95% sure it should not be possible... but I leave the 5% as I am not like an SP PRO (I think it is hard to be one as it is like sooooo much to know )

possible solution you might take

What you might do is to add the custom Ribbion xml using PowerShell and attach any javascript logic to it also using PowerShell . The only drawback is that the javascript file needs to be also somehow added to the page (like it could be stored in the SiteAssets library).

So to do that we need to:

create an xml file locally with our Ribbon command button like:

<CommandUIExtension>
    <CommandUIDefinitions>
        <CommandUIDefinition Location="Ribbon.Library.ViewFormat.Controls._children">
            <Button Id="Ribbon.Library.ViewFormat.About"
                Command="TestButton"
                LabelText="Test"
                Image32by32="{SiteUrl}/_layouts/15/1033/Images/formatmap32x32.png?rev=23"
                Image32by32Top="-273"
                Image32by32Left="-1"
                Description="Test"
                TemplateAlias="o1" />
        </CommandUIDefinition>
    </CommandUIDefinitions>
    <CommandUIHandlers>
        <CommandUIHandler
            Command="TestButton"
            CommandAction="javascript:test({SelectedItemId});"
            EnabledScript="javascript:checkOneItemSelected();" />
    </CommandUIHandlers>
</CommandUIExtension>

the output of the above will be a button like this

Next create a js file (also locally) with functions for the CommandAction and EnabledScript (so we need a test() function and checkOneItemSelected()). So the contents like

function test(itemId) {
    alert(itemId);
}

function checkOneItemSelected() {
    return (SP.ListOperation.Selection.getSelectedItems().length == 1)
}

... so locally I have two files

Now we need to connect to the site we want to add the Ribbon button using PowerShell (best would be to use PnP Powershell )

connect to site using Connect-PnPOnline -Url <SiteUrl>
now lets add the JS local file to the site assets library like Add-PnPFile -Path .\customJS.js -Folder "SiteAssets"

so the output is (the file in the library)

now lets add the Ribbon button to the site (using xml) like

$ribbon = Get-Content .\CustomRibbonButton.xml
$ribbon = [string]$ribbon
Add-PnPCustomAction -Name "RibbonTester" -Title "RibbonTester" -Description "-" -Group "Tester" -Location "CommandUI.Ribbon" -CommandUIExtension $ribbon -RegistrationType ContentType -RegistrationId 0x0101

so the output of the above will be our button in the ribbon (also we need to turn on classic UI /off modern UI, to see the ribbon )

now lets attach our JS to the button like Add-PnPJavaScriptLink -Name "AboutButtonScript" -Url https://tenanttocheck.sharepoint.com/sites/ClassicDeveloperSite/SiteAssets/customJS.js -Scope Web please be aware the change url to your tenant

and the output is like

did you consider

Also did you consider to use spfx extensions and modern UI to be more up to date? In extensions you may use JS and maybe do some http request to some endpoint you want to target with the ids array (but this is only a suggestion)

hope my post will be of any help BR

Thanks Adam for the answer. We want to offer the add-in in the store so i'm not sure if is possible the pnp method for every customer who installs it. — alejandro Guevara, Feb 18 '21 at 09:44
a ok.. I didn't know that was one of the requirements .Sure, my solution seems more like a workaround . If you want to do all together with add-in being installed you could try to add the add-in AppInstalled Event -> https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/handle-events-in-sharepoint-add-ins#appinstalled-event. basically it is an event that runs (c# code) when the app is installed. I think you should be able to add a custom ribbon button to, but I would need to research it/try it myself. Unfortunately for the next 2 weeks I won't have much time but maybe you may try — Adam, Feb 19 '21 at 21:23

Can Custom Action Buttons run javascript in handler? Sharepoint add-in

1 Answers1

is it possible? ... I suppose no

possible solution you might take

did you consider