Person Web Part Documentation

This is the documentation for the Bandido+ person sharing service web part.

URLs

• Dev: http://story.bandido.ajax.ancestrydev.com/webparts/story.json
• Stage: http://story.bandido.ajax.ancestrystage.com/webparts/story.json
• Production: http://story.bandido.ajax.ancestry.com/webparts/story.json

Prerequisites

In order for the web part button click JSONP call to work, the request must contain a valid ATT cookie that is associated with a user who can access the shared content. Thus, to completely test the web part, we recommend that you push code to dev or stage and login as a valid Ancestry user beforehand.

Dependencies

Required:

• jQuery 1.7+

Optional:

• Default Ancestry global styles: http://c.mfcreative.com/lib/tgn/combo.ashx?x/css/v1/deprecated_reset.css&x/css/v1/deprecated_oldoldglobal.css&x/css/v1/deprecated_clearfix.css&x/css/v1/deprecated_containers.css&x/css/v1/deprecated_flat_icon.css&x/css/v1/deprecated_subnav.css&x/css/v1/deprecated_widgets.css&x/css/v1/deprecated_dialogpanel.css&x/css/v1/deprecated_pagination.css&x/css/v1/deprecated_subtabs.css&x/css/v1/deprecated_alerts.css&x/css/v1/deprecated_sidenav.css&x/css/v1/deprecated_accordian.css&x/css/v1/deprecated_sharecontrol.css&x/css/v1/deprecated_panels.css&x/css/v1/deprecated_tabs.css&x/css/v1/deprecated_subcontainers.css&x/css/v1/deprecated_buttons.css&x/css/v1/deprecated_tags.css&x/css/v1/deprecated_form.css&x/css/v1/deprecated_sectionhead.css&x/css/v1/deprecated_subtabnav.css&x/css/v1/deprecated_timeline.css&x/css/v1/deprecated_modals.css&x/css/v1/deprecated_newheadercompatibility.css
• Default Ancestry button styles: http://c.mfcreative.com/lib/tgn/combo.ashx?x/css/v1/main.css&x/css/v1/buttons.css

Example HTML

<div id="ShareRegion" data-tree-id="116448" data-person-id="18003641377" data-referrer-client="website-stage" data-referrer-page="example-share-webpart" data-person-name="Peter Akira Graham" data-person-first-name="Peter">
</div>

HTML data attributes

The following specifies data attributes that you should add for the parent <div> of the web part.

• Required
  • data-tree-id the tree ID of the person that is being shared
  • data-person-id the person ID of the person that is being shared
  • data-referrer-client for the website, this should be "website", "website-stage", or "website-dev". For iOS this should be "ios")
  • data-referrer-page the name of the page that this web part is being implemented on (e.g. "interactive-image-viewer", "all-hints", etc.)
  • data-person-name the name of the person being shared
  • data-person-first-name the first name of the person being shared
• Optional
  • data-locale - see below for details

locale

String or Windows codes (as strings or integers)

"en-US" : 1033
"en-CA" : 4105
"fr-CA" : 3084
"en-UK" : 2057
"sv-SE" : 1053
"it-IT" : 1040
"de-DE" : 1031
"fr-FR" : 1036

Button styles

There is only a single button style which currently cannot be customized unless you override our CSS. We may add more button styles in the future.

Web part region IDs

Region CSS ID can be specified using the region= GET param to allow for multiple bandido web parts on the same page. The default CSS ID is ShareRegion.