Skip to content

Latest commit

 

History

History
102 lines (76 loc) · 5.5 KB

README.md

File metadata and controls

102 lines (76 loc) · 5.5 KB

Integration Theme Example: Styling with external CSS

Version: 1.0.1

DriveWorks Versions: 18.0 - 20.3

For styling via CSS in DriveWorks 21.0 and above, see: Styling with ProjectStyles.css

A distributable example that demonstrates how to style DriveWorks Controls using external CSS.

Please note: DriveWorks are not accepting pull requests for this example.
Join our online community for discussion, resources and to suggest other examples.

This example:

  • Demonstrates using basic Metadata & CSS selectors, and further advanced styling that CSS enables.
  • Provides 2 DriveWorks Packages (.drivepkg), each containing an example Project that demonstrate use of the "Metadata" Property and styling various Properties.
    • BasicStyles18.drivepkg - Demonstrates using "Metadata" & basic CSS selectors to target DriveWorks Controls.
      • See also: /basic-styles/styles.css
    • AdvancedStyles18.drivepkg - Demonstrates some possibilities for advanced styling made available via CSS.
      • See also: /advanced-styles/advanced-styles.css

The CSS selectors/styles demonstrated can be viewed without installing the provided Projects, for quick reference. Simply open the included .css files.

/basic-styles

Basic Example

  • Creates a new Specification
  • Loads in a custom stylesheet (/basic-styles/styles.css)
  • Styles a single Macro Button control - using the Project 'BasicStyles18'
  • Demonstrates:
    • Targeting controls with the "Metadata" Property (data-metadata)
    • Using CSS Attribute Selectors
    • Rounded Corners (border-radius)
    • Shadows (box-shadow)
    • Animating styles (transition)
    • Rotate and Scale (transform)
    • Gradients (linear-gradient)
    • Hover styles (:hover)
    • Styling child elements

/advanced-styles

Advanced Example

  • Creates a new Specification
  • Loads in an alternate custom stylesheet (/advanced-styles/advanced-styles.css)
  • Styles multiple Controls - using the Project 'AdvancedStyles18'
  • Demonstrates:
    • Various 'button' styles
    • CSS Transforms (rotate/scale/skew)
    • CSS Filters (blur, grayscale)
    • Animating changes
      • Position (top/left)

To use:

  1. Clone this repository, or download as a .zip.

  2. Extract each of the supplied .drivepkg files using the DriveWorks Package Wizard to access the included Project files.

  3. Open the extracted Groups in DriveWorks Administrator and use 'Form Design' to view each Controls and its Properties.

    • Most importantly: the "Metadata" Properties that are targeted via CSS.

  4. In DriveWorksLiveConfigUser.xml, add a new Group Alias for the each new Group containing the example Projects.

  5. Open the extracted Groups in DriveWorks Live and start the Integration Theme.

  6. Enter your Integration Theme details into config.js for each example.

    • serverUrl - The URL that hosts your Integration Theme, including any ports.
    • groupAlias - The public alias created for the Group containing the DriveApps to render - as configured in DriveWorksConfigUser.xml.
      • This must be specified for each Group you wish to use.
      • This allows you to mask the true Group name publicly, if desired.
      • See Integration Theme Settings for additional guidance.
    • projectName - The name of the Project to render a Specification from.
      • These are pre-filled with supplied Project names, but can be changed if required.

  7. Ensure that the Integration Theme server is running, using any of the available methods (e.g. Personal Web Edition, DriveWorks Live, IIS)

  8. Open the example HTML files locally (localhost) or on a remote server.

    • Ensure <corsOrigins> in DriveWorksConfigUser.xml permits request from this location. See Integration Theme Settings for additional guidance.

  9. If encountering any issues, check the browser's console for error messages (F12)

Potential Issues:

  • When serving this example for a domain different to your DriveWorks Live server, e.g. api.my-site.com from company.com, 'SameSite' cookie warnings may be thrown when the Client SDK attempts to store the current session id.
    • This appears as "Error: 401 Unauthorized" in the browser console, even with the correct configuration set.
    • To resolve:
      • Ensure you are running DriveWorks 18.2 or above, HTTPS is enabled in DriveWorks Live's settings and a valid SSL certificate has been configured via DriveWorksConfigUser.xml.
      • See Integration Theme Settings for additional guidance.

This source code has been made available to demonstrate how you can integrate with DriveWorks using the DriveWorks Live API. This code is provided under the MIT license. For more details, see the included LICENSE file.

The example requires that you have the latest DriveWorks Live SDK installed, operational and remotely accessible.