Changeset 8041

Timestamp:

Jun 2, 2022, 2:55:24 PM (8 months ago)

Author:

Nicklas Nordborg

Message:

References #2278: Improvements to login page for better extensions

Updated some developer documentation.

File:

• branches/3.19-stable/doc/src/docbook/developer/extensions.xml (modified) (3 diffs)

branches/3.19-stable/doc/src/docbook/developer/extensions.xml

@@ -2686 +2686 @@
       </sect3>
       
-      <sect3 id="pextensions_developer.login-manager.settings">
+      <sect3 id="extensions_developer.login-manager.settings">
         <title>Configuration settings</title>
       
@@ -2747 +2747 @@
         <para>
           All installed and enabled login forms are available in a selection list
-          from which the user can select to switch to another login form. For technical reasons 
-          custom scripts and stylesheets are loaded for all installed login forms even
-          though only one is displayed at a time. Developers must ensure that CSS rules
-          and scripts are not affecting other login forms than the intended one.
+          from which the user can select to switch to another login form. Since BASE 3.19.3
+          custom scripts and stylesheets are only loaded for the currently active form.
+          In earlier BASE versions, custom scripts and stylesheets were loaded for all installed 
+          login forms.
         </para>
         <para>
-          To help with this, BASE is setting two data-attributes on the 
+          It is possible for both style sheets and scripts to verify that they are only used on
+          the intended login form. BASE is setting two data-attributes on the 
           <sgmltag class="starttag">body</sgmltag> tag:
         </para>
@@ -2816 +2817 @@
       </note>
       
+      <sect3 id="extensions_developer.login-form.before-login">
+        <title>The before-login event</title>
+      
+        <para>
+          In BASE 3.19.3 the <code>before-login</code> was introduced. It is a custom event
+          that is sent to the <sgmltag class="starttag">form</sgmltag> tag just before the
+          login form is submitted to the server. Extensions may add event listeners for this
+          event if they need to take some action and they have the possibility to cancel
+          the submission by calling the <code>event.preventDefault()</code> method.
+        </para>
+        
+        <para>
+          This functionality is, for example, used by the <ulink 
+          url="https://baseplugins.thep.lu.se/wiki/net.sf.basedb.webauthn">WebAuthn</ulink> extension,
+          which need to contact the server to get a <emphasis>challenge</emphasis>, ask the user
+          to insert and click on the security key, and then return the signed challenge in the
+          <code>extraField</code> before the login form is actually submitted. Since all of this
+          is handled asynchronously the <code>before-login</code> event need to be cancelled. The login
+          form can be submitted by calling <code>Login.submitLoginForm()</code>.
+        </para>
+      </sect3>
     </sect2>