pwix:app-edit

What is it ?

A package which helps an application to manage inline editable documents. It relies on pwix:core-app and extends the CoreApp.RunContext class with a IAppEditable interface.

Features

When an application manages inline editable documents, following features are to be managed:

• have an edit button to let the user edit the document; this button may be hidden, on, or off

• have a Blaze component to visually edit the document

• have storage collections to record the document depending of the chosen language.

Provides

AppEdit

The exported AppEdit global object provides following items:

Classes

Interfaces

IAppEditable

The IAppEditable interface extends the CoreApp.RunContext class with folllowing methods:

• async ieditableAllowed(): Boolean

  Whether the user is allowed to edit the current document.

  Use the allowFn configuration option, defaulting to false.

  pwix:app-edit needs two additional DisplayUnit parameters to manage the display of the edit toggle button and the permissions of the user to actually edit the document:

  • wantEditionSwitch: whether the edit toggle button must be displayed

  • wantEditionRoles: the roles needed by the user to be allowed to edit the current page documents.

• ieditableAsked( [ask<Boolean>] ): Boolean

  A getter/setter which says if the user has asked for editing the current document.

Functions

AppEdit.configure()

See below.

A reactive data source.

AppEdit.i18n.namespace()

Returns the i18n namespace used by the package. Used to add translations at runtime.

Blaze components

AppEditButton

Displays (or not) a toggle button to let the user enter in edition mode on the current page.

The component is configurable through the package configuration as there is most probably only one such toggle switch in the application.

Permissions management

This package can take advantage of pwix:permissions package to manage the user permissions through the configured allowFn() function.

Two additional DisplayUnit tags are defined here:

• wantEditionSwitch whether the page should present an edition switch to the user

• wantEditionRoles whether the user is allowed to edit the page documents.

Configuration

The package's behavior can be configured through a call to the AppEdit.configure() method, with just a single javascript object argument, which itself should only contains the options you want override.

Known configuration options are:

• allowFn

  An async function which will be called with an action string identifier, and must return whether the current user is allowed to do the specified action.

  If the function is not provided, then the default is to deny all actions.

  allowFn prototype is: async allowFn( action<String> [, ...<Any> ] ): Boolean

• collection

  The name of the documents collection(s), defaulting to contents.

• toggleHiddenWhenNotConnected

  Whether the toggle button must be shown and disabled when user is not connected, or hidden.

  Defaults to true: button is hidden.

• toggleHiddenWhenUnallowed

  Whether the toggle button must be shown and disabled when user is connected but not allowed, or hidden.

  Defaults to true: button is hidden.

• verbosity

  Define the expected verbosity level.

  The accepted value can be any or-ed combination of following:

  • AppEdit.C.Verbose.NONE

    Do not display any trace log to the console

  • AppEdit.C.Verbose.CONFIGURE

    Trace AppEdit.configure() calls and their result

Please note that AppEdit.configure() method should be called in the same terms both in client and server sides.

Remind too that Meteor packages are instanciated at application level. They are so only configurable once, or, in other words, only one instance has to be or can be configured. Addtionnal calls to AppEdit.configure() will just override the previous one. You have been warned: only the application should configure a package.

NPM peer dependencies

Starting with v 0.1.0, and in accordance with advices from the Meteor Guide, we no more hardcode NPM dependencies in the Npm.depends clause of the package.js.

Instead we check npm versions of installed packages at runtime, on server startup, in development environment.

Dependencies as of v 1.0.0:

1    'lodash': '^4.17.0',
2    '@vestergaard-company/js-mixin': '^1.0.3'

Each of these dependencies should be installed at application level:

    meteor npm install <package> --save

Translations

New and updated translations are willingly accepted, and more than welcome. Just be kind enough to submit a PR on the Github repository.

Cookies and comparable technologies

None at the moment.

Issues & help

In case of support or error, please report your issue request to our Issues tracker.

---

P. Wieser

• Last updated on 2024, Oct. 4th