Have ideas to improve npm?Join in the discussion! »

    apostrophe-personas

    3.0.5 • Public • Published

    apostrophe-personas

    This module helps you specialize the content of each page of an Apostrophe site based on the user's primary affiliation. Here are good examples:

    • Employee versus employer
    • Trucks versus cars
    • "Prosumer" versus low-end gear

    Consider the employee versus employer example. Every widget on the site can be designated as universal, employee-oriented, or employer-oriented. By default, users see all of these, as the site doesn't yet know which is relevant.

    But as soon as the user takes action to indicate their employee status, a prefix is added to the URL and they see only universal widgets and employee widgets, unless they decide to switch back.

    Also, pages can be designated as oriented toward one persona or the other. This can be used to avoid showing them as navigation options to uninterested parties.

    Page URLs are always prefixed based on the active persona, which improves bookmarking and social sharing outcomes as well as allowing search engines to index them with different content subsets.

    Example

    // in app.js
    modules: {
      'apostrophe-personas': {
        personas: [
          {
            name: 'employee',
            label: 'Employee',
            prefix: '/employee'
          },
          {
            name: 'employer',
            label: 'Employer',
            prefix: '/employer'
          }
        ]
      }
    }

    Personas and workflow

    This module can optionally be used together with the apostrophe-workflow module. If so, the workflow module must be configured first.

    When workflow is present, any URL prefix for the workflow locale comes first, and the persona prefixes themselves should be localized. Here is an example.

    // in app.js
    modules: {
      'apostrophe-workflow': {
        locales: [
          {
            name: 'en',
            label: 'English'
          },
          {
            name: 'fr',
            label: 'French'
          }
        ],
        prefixes: {
          'en': '/en',
          'fr': '/fr'
        }
      },
      'apostrophe-personas': {
        personas: [
          {
            name: 'employee',
            label: 'Employee',
            prefixes: {
              'en': '/employee',
              'fr': '/employé'
            }
          },
          {
            name: 'employer',
            label: 'Employer',
            prefixes: {
              'en': '/employer',
              'fr': '/employeur'
            }
          }
        ]
      }
    }

    The resulting URLs look like:

    /en/employer/about /fr/employeur/about

    Of course the admin can edit the /about part of the French slug to suit the language. That's an apostrophe-workflow feature.

    Both of these URLs reference the same persona, but in different locales.

    Since a single doc object serves all personas, the persona prefix does not become part of the slug in the database. The URL is rewritten dynamically as needed.

    If you do not specify the prefixes option, or leave out locales, a warning is printed, as an untranslated prefix is usually not what you really want.

    Constructing links to a specific persona

    Normally, links generated to pages or pieces on the site will have the same persona prefix that is already present in the address bar for the current page.

    However it is possible to create link widgets that link to a user-specified persona.

    To do that, just create your own link widget as you normally do, and include a field called linkToPersona.

    You may specify an empty choices array, in which case apostrophe-personas will fill in the choices for you. Or, you may specify the exact choices you want to offer, in which case they must exactly match the persona names in your apostrophe-personas configuration.

    Make sure the widget also has a joinByOne or joinByArray field whose withType property is set to apostrophe-page, or to a piece type which has corresponding pieces-pages on the site (or otherwise generates a valid _url property when loaded). Note that it must be at the same level of the schema.

    When you do so, apostrophe-personas will automatically detect this situation and correct the generated links to match the specified persona.

    Note that if you are completely overriding the load method of your widget without calling the original version of the method, this mechanism will not work automatically. However it is also possible to call the addPrefix(req, personaName, url) method of the apostrophe-personas module to retrieve a version of any URL that has been corrected for the specified persona.

    Forcing persona selection

    If the disableEmptyUniversal option is set to true, this option forces a persona to be selected at all times. When a universal document is requested with no persona prefix, the user is redirected to the persona found in options.defaultPersonaByLocale (an object with values for each locale), or to options.defaultPersona, or finally to the first configured persona.

    Because this option will cause a redirect to add the prefix for the persona, code for custom routes may occasionally respond in surprising ways. You can disable the effect of this option for such URLs via the neverForcePersona option, which can be set to an array of URLs. It is concatenated with minimumNeverForcePersona, which defaults to:

    minimumNeverForcePersona: [ '/login-totp', '/setup-totp', '/confirm-totp' ]

    Detecting the persona in templates

    In your templates, data.persona indicates the current persona.

    data.isPersonaUniversalContext will be true if the current document has a universal persona (useful for persona switcher display in authoring).

    data.personaSwitched indicates that the persona just changed.

    Install

    npm i apostrophe-personas

    DownloadsWeekly Downloads

    28

    Version

    3.0.5

    License

    MIT

    Unpacked Size

    66.7 kB

    Total Files

    32

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar