Permalink
4e68261 Mar 22, 2018
1 contributor

Users who have contributed to this file

77 lines (40 sloc) 3.92 KB

Setup & Configuration

The deployment & configuration for Column Formatter is no different than most client-side webparts. While you can certainly build it yourself, the app package is also located here.

The whole process takes 2-5 minutes.

Deployment

To get started, you'll need to upload the web part package to your app (or site) catalog. This will require administrator rights so you may have to hand it off to someone in IT for these steps.

  1. Upload or drag and drop the package to the catalog:

Dragging onto the App Catalog

  1. The Trust Confirmation dialog will appear. Depending on how you've setup/enabled the Public CDN in your environment, the listed domains may vary from those shown below.

All code and assets are included in the app package and nothing is loaded from external domains

  1. Check the box to Make this solution available to all sites in the organization (this will allow any site to add it to a page - leave this unchecked if you only want to add it to specific sites).
  2. Click Deploy:

Trust Confirmation

Additional details and examples of this process can be found here.

Adding it to a Site

You can add Custom Formatter to a page (classic or modern) just as you would any other webpart.

Add to a site

Note -If tenant deployment wasn't enabled, then the app will have to be added to the site like any other app from the Site Contents page.

Full-Width Sections

Column Formatter can be added to any page, but adding it to a full-width section allows you to get the most real estate possible.

You can add a full-width column by editing the section layout and choosing Full-width column.

Adding a full-width Column

Next, select Column Formatter from the full-width webpart choices.

Choosing Column Formatter in a full-width column

Configuration

There are several properties available in the property pane that can be adjusted at any time.

Updating Column Formatter

If you've previously deployed Column Formatter but want all the new stuff - Good News! Column Formatter is super easy to update.

Just like the initial deployment you'll need to upload the web part package to your app (or site) catalog. This will require administrator rights so you may have to hand it off to someone in IT for these steps.

  1. Upload or drag and drop the package to the catalog:
  2. You will prompted to replace the existing solution, click Replace it:

Replace existing solution

  1. The Trust Confirmation dialog will appear. Depending on how you've setup/enabled the Public CDN in your environment, the listed domains may vary from those shown below.

All code and assets are included in the app package and nothing is loaded from external domains

  1. Check the box to Make this solution available to all sites in the organization (this will allow any site to add it to a page - leave this unchecked if you only want to add it to specific sites).
  2. Click Deploy:

Trust Confirmation

Next Steps