Add-SPOTheme

Reference

Module:: Microsoft.Online.SharePoint.PowerShell

Applies to:: SharePoint Online

Creates a new custom theme, or overwrites an existing theme to modify its settings.

Syntax

Add-SPOTheme
   -Identity <SpoThemePipeBind>
   -IsInverted <bool>
   -Overwrite
   -Palette <SpoThemePalettePipeBind> 
   [<CommonParameters>]

Description

The Add-SPOTheme cmdlet creates a new theme or updates an existing theme. The color palette settings can be passed as either a hash table or a dictionary.

Adding a theme does not apply the theme to any sites. It adds the theme to your tenant store, and then the theme is available in the list of themes under the Change the look option for modern pages.

Examples

Example 1

In this example, a new theme named "Custom Cyan" is created, with color palette settings that are various shades of cyan. Note that the settings are passed as a hash table.

$themepalette = @{
  "themePrimary" = "#00ffff";
  "themeLighterAlt" = "#f3fcfc";
  "themeLighter" = "#daffff";
  "themeLight" = "#affefe";
  "themeTertiary" = "#76ffff";
  "themeSecondary" = "#39ffff";
  "themeDarkAlt" = "#00c4c4";
  "themeDark" = "#009090";
  "themeDarker" = "#005252";
  "neutralLighterAlt" = "#f8f8f8";
  "neutralLighter" = "#f4f4f4";
  "neutralLight" = "#eaeaea";
  "neutralQuaternaryAlt" = "#dadada";
  "neutralQuaternary" = "#d0d0d0";
  "neutralTertiaryAlt" = "#c8c8c8";
  "neutralTertiary" = "#a6a6a6";
  "neutralSecondaryAlt" = "#767676";
  "neutralSecondary" = "#666666";
  "neutralPrimary" = "#333";
  "neutralPrimaryAlt" = "#3c3c3c";
  "neutralDark" = "#212121";
  "black" = "#000000";
  "white" = "#fff";
  "primaryBackground" = "#fff";
  "primaryText" = "#333"
 }

Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false

Note

Prior to the December 2017 release of the SPO Management Shell, the Add-SPOTheme cmdlet required that color palette settings be passed as a dictionary. We recommend that you use the latest version of the SPO Management Shell, or use the HashToDictionary function to convert a hash table to a dictionary if needed.

Example 2

If you want to update an existing theme (to modify some of its color settings, for example), use the same syntax as shown previously, but add the -Overwrite flag to the Add-SPOTheme cmdlet.

Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false -Overwrite

Parameters

-Identity

Specifies the name of the theme. This must uniquely identify the theme.

Type:	SpoThemePalettePipeBind
Aliases:	Name
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-IsInverted

Specifies whether the theme is inverted, with a dark background and a light foreground.

Type:	Boolean
Aliases:	None
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-Overwrite

Overwrites a theme of the same name in case it exists.

Type:	SwitchParameter
Aliases:	None
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online

-Palette

Specifies the palette of colors in the theme, as a dictionary of theme slot values.

Type:	SpoThemePalettePipeBind
Aliases:	None
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Online