sp-dev-fx-webparts/samples/react-target-audience
Hugo Bernier 68f7f67761 Changed from updated to modificationDateTime 2021-05-02 15:39:42 -04:00
..
assets Changed from updated to modificationDateTime 2021-05-02 15:39:42 -04:00
config Adding PnP identifier for the MPN ID entries in samples - distinct sample usage in production 2021-01-07 14:51:39 +02:00
src Updated readme 2020-12-16 23:04:55 -05:00
teams Added sample for target audience component 2020-12-16 11:23:40 +10:00
README.md Fixed spacign 2020-12-16 23:10:08 -05:00
gulpfile.js Added sample for target audience component 2020-12-16 11:23:40 +10:00
package-lock.json Added sample for target audience component 2020-12-16 11:23:40 +10:00
package.json Added sample for target audience component 2020-12-16 11:23:40 +10:00
tsconfig.json Added sample for target audience component 2020-12-16 11:23:40 +10:00
tslint.json Added sample for target audience component 2020-12-16 11:23:40 +10:00

README.md

Target audience generic component

Summary

Sample web part which uses a Generic React Component which enables it to have Target Audience functionality like what was available in classic web parts. Targets SharePoint Groups only within the site.

audience.gif

Compatibility

SPFx 1.11

Node.js LTS 10.x

SharePoint Online

Teams N/A

Workbench Local | Hosted

Applies to

Solution

Solution Author(s)
target-audience-generic-component Rabia Williams(@williamsrabia , rabiawilliams.com)

Version history

Version Date Comments
1.0 Jan 28, 2020 Initial release

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.


Minimal Path to Awesome

  • Clone this repository
  • in the command line run:
    • npm install
    • gulp serve
  • Define one or more groups to use as an audience
  • Add the web part to a page
  • In the web part's properties, select the audience you wish to see the web part

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • Adding audience targeting to web parts using a generic React component

When the web part is configured, the sample content will only appear to users who belong to the targeted audience.

You can use the TargetAudience control (located under src/common/TargetAudience.tsx) by inserting one or more in your web parts, specifying the pageContext and groupIds props, and adding the content you wish to show/hide as children elements of the TargetAudience control, as follows:

<TargetAudience pageContext={this.props.pageContext} groupIds={this.props.groupIds}>
    <div>
        Your sample content goes here
    </div>
</TargetAudience>