axure-redline-tool

An interactive redline tool plugin for Axure remotely-hosted projects.

Stats

StarsIssuesVersionUpdatedCreatedSize
axure-redline-tool
43123.1.19 months ago4 years agoMinified + gzip package size for axure-redline-tool in KB

Readme

Axure Interactive Redline Tool

This plugin intends to mimic some of the functionality of the plugin Measure for Sketch or InVision Inspect. This application is meant for those who rely on Axure in their organizations and would like to provide developers with always-up-to-date design specifications. As Axure does not support plugins within the application itself, this code resides within and is applied to your AxShare projects.

Super Basic Demo

Plugin Usage

Latest Version

<script src="https://cdn.jsdelivr.net/npm/axure-redline-tool@latest/web/axure-redline-plugin.js"></script>

Current Version

<script src="https://cdn.jsdelivr.net/npm/axure-redline-tool@3.1.1/web/axure-redline-plugin.js"></script>

There are several ways to use this "install" this plugin. The easiest option is to copy the script link above into your AxShare project as a plugin. Copy the script of the version you'd like to use, or simply use the script marked "latest" to ensure you're always subscribed to the latest application updates. The code in the scripts above is served from a CDN to ensure a fast response, no matter your location. If you prefer to house the code directly in your AxShare project, you'll need to copy and paste the code found within /axure-redline-tool/web/plugin.txt into your AxShare project as a plugin. The code combination is derived from the markup framework, CDN links, the pertinent CSS, and the supporting JavaScript / jQuery code base.

To apply this code to one of your AxShare hosted projects, navigate to www.share.axure.com and log into your account. Once logged in, you will see an inline gear icon to the far right of each Axure project. Hovering over this icon provides a list of options, including PLUGINS which you should select. Once on the plugin page, select NEW PLUGIN. Name your plugin whatever you deem appropriate and select End of the Head as the insertion location. Paste your plugin.min.htm code into the content area and save the plugin. Select all desired pages within which you'd like to have the interactive redline tool. If you would like to have the plugin appended to any new pages, you may select Add to new pages by default. Once saved, your plugin should be activated. To modify the plugin, simply select edit and paste in any replacement code.

Previous Releases

Axure Plugin Tutorial

plugin demo

Installation / Running

Install Node.js

Update npm to the latest version:

$ npm install npm@latest -g

To launch a demo instance of the plugin in your browser, issue the following commands:

$ cd axure-redline-tool
$ npm install
$ gulp develop

Prerequisites / Dependencies

This project was built and tested on jQuery 3.2 and Axure RP.

Building Modified Plugin

If you've made changes and would like to build an updated version of the plugin, run the following commands to generate plugin.txt and plugin.js. Copy the contents of plugin.txt into your AxShare project as shown above.

If you would like to modify the plugin, two build scripts are available to aid in this.

To quickly build your changes for production issue the following commands:

$ cd axure-redline-tool
$ npm install
$ gulp build-prod

Because this is a compiled plugin i.e. HTML, CSS, and JS are merged into one file, you can also keep the plugin continuously watching for source changes. This will then automatically rebuild the plugin.txt file and you may then copy the plugin code directly into AxShare. This will not open an instance of the plugin in your browser. For this, issue the following commands:

$ cd axure-redline-tool
$ npm install
$ gulp build-watch

Bugs / Drawbacks

As this code is embedded within Axure projects, it does not have direct control of how assets are exported from within Axure. Additionally, Axure projects allow much more functionality and interactivity than those generated in Sketch and it's difficult to intercept and interact with these. The code makes every attempt to handle the various nested elements exported from Axure, but if you do encounter an issue, please let me know and I'll promptly resolve it.

You may find the generated artboard sizing odd during initial use. This tool scans all page elements and sizes the artboard based on the most-extreme elements. If you would like a specific size artboard, I would suggest using a background rectangle within Axure to define this. Alternatively, you may use a combination of vertical and horizontal lines to define your artboard border. For example, if you would like an artboard of 1000px x 1000px, place a rectangle as the backmost element in your Axure project with a X and Y location of 0 and dimensions of 1000px x 1000px.

*Axure chooses to export some common elements such as circles and lines as images instead of using CSS. As such, you may find it difficult to find accurate dimensions on some items. A workaround for circles is to place a square in Axure and set the border radius greater than or equal to 50% of the square's dimensions. This will then export as an HTML element. Axure also has difficulties in exporting elements with lots of border attributes and box shadows. It typically exports these as images and you will be unable to retrieve any CSS attributes.

Coming Features

  • Provide Sliced Images
  • Document Color Palette

Versioning

We use SemVer for versioning.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Change Log

Version 1.1

  • Resolved the issue of overflow scrolling content affecting artboard sizing. In Axure terms, hidden dynamic panel content no longer causes the generated artboard to be bigger than visible elements.
  • Resolved how the tool handles Axure annotations. Annotations can be read while the tool is disabled. While the tool is enabled, their icons are not considered interactive elements.
  • Added key command functionality to support zoom controls through [Ctrl +] / [Ctrl -] and Esc key to close the redline tool panel / deselect the element.
  • Added zoom tracking support to ensure current zoom level is maintained while progressing through flows.

Version 1.1.1

  • Revised code to handle artboard rendering issues. Axure uses images instead of CSS for many common elements such as lines and circles. These exported images often have incorrect dimensions which cause the redline tool to incorrectly size the artboard. The code has been revised accordingly to handle these scenarios.
  • The tool now removes element focus when the page is scrolled. This issue caused the orange selection box to remain fixed while the element below was scrolled. Code currently closes the redline tool when scrolling occurs. Later enhancement will be to bind orange selection box to the element selected so that even with scrolling the box remains.

Version 1.1.2

  • Build scripts have been ported from Grunt to Gulp. Additional build options are now available, and the code injection has been improved.

Version 1.1.3

  • Provided color swatch preview for color and background-color attributes.
  • Now support HEX and RGB(A). Color formats can be toggled by clicking color swatch.

Version 1.1.4

  • Provided support for repeater widgets. Updated code to ignore embedded script and style tags.
  • Added box-sizing attribute to inputs to ensure correct sizing across browsers.

Version 1.2

  • Revised how inter-element dimensions are calculated. Previously, all elements were iterated, and data attributes appended. Now this is done in real-time, on only the active elements. This will help performance on pages with many elements.
  • Resolved issue where the tool displays unintended hidden content.
  • Resolved small CSS styling changes to improve consistency in displaying attributes.
  • Resolved issue where tool throws error when disabling while an element is selected.
  • Tool now provides correct artboard padding when zooming.
  • Resolved measurement flicker which occurred when hovering over a measurement line or tag.

Version 2.0.1

  • Axure Component Names - The tool will now display any element names you've used in your project.
  • Annotations Always Clickable - Annotations are always available to click, even when the tool is enabled.
  • Move Redline Switch - The redline tool enable switch has been moved to the top header for better visibility.
  • Show Pseudo Class Attributes - The tool now provides CSS for those pseudo classes provided by Axure.
  • CDN Link - The tool can now be served from a CDN link which means faster load times and no more copying of huge blocks of code.
  • Hotkey Interactions - Now it is no longer required to disable the tool to interact with Axure elements. By holding down [Ctrl] (Windows) or [⌘] (Mac) you can hover over or click on elements.
  • Business / Developer Links - The tool now offers up sharing links for both business and developers. The business link will prevent the tool from even rendering itself on the page. This ensure there is no confusion when sharing your prototypes with business.
  • Loading Spinner - On large pages the tool can take quite long to render the artboard. A loading spinner helps to indicate background action.
  • Color Swatches - Updated code to handle color swatches for any CSS attribute containing a color.
  • Parent Opacity - When adjusting opacity for the entire element in Axure, it is only applied to the parent. The tool now can accurately extract this information.

Version 2.0.3

  • Added CSS block properties field for easy cut and paste.

Version 2.0.4

  • When RGBA colors are displayed with an opacity of 1, we now convert them to RGB.
  • If a CSS attribute opacity is 1, we now don't bother displaying it.
  • Resolved bug in Microsoft Edge creating issues when displaying RGBA color values.

Version 2.0.5

  • When sharing the business link, annotations are disabled by default through the AxShare interface panel.

Version 2.0.6

  • Revised how sharing links are formed to accommodate private enterprise server links.

Version 2.0.7

  • Corrected page loading of HTML, CSS, and Google fonts. Loading of fonts was causing incorrect jQuery measurements of elements.
  • Updated CSS to support RP9 artboard generation.
  • Updated to support RP9 annotations.

Version 3.0.0

  • Ported application to React.
  • Slight UI modifications.
  • Grid overlay support.

Version 3.0.1

  • Corrected plugin path.

Version 3.0.2

  • Added support for native inspect tool and Axure Cloud.

Version 3.0.3

  • Corrected splash screen modal body issue.

Version 3.0.4

  • Resolved interaction bugs with native inspect tool.
  • Resolved artboard padding click error.
  • Revised build tools for legacy support, ensuring no breaking changes.

Version 3.0.5

  • Removed click functionality from #base which is essentially the artboard and shouldn't be interacted with.
  • Added opacity to #base artboard to style it more like a non-interactive element.

Version 3.0.6

  • Added additional functionality to support jumping artboard in RP9 projects and projects using native inspect tool.

Version 3.0.7

  • Corrected artboard background color configuration. For undefined artboard backgroud colors, the artboard is rendered as transparent white. Otherwise, the user-defined color is used.
  • Added functionality to dev-live script to support serving a custom URL.

Version 3.1.0

  • Corrected CSS Color Name Matching - The Redline Tool supports the use of CSS color names in lieu of hex/RGB values. The matching algorithm which displays the swatch for the given color was partially matching other words. This meant if the field value was bored, a red color swatch was applied.
  • Added Modal Inspection Support - Modals or other elements which break out of the normal page flow were being incorrectly read by the tool. From a technical aspect, this was occurring on elements with position: fixed;.
  • Border Color Shown With No Border - On text blocks, the tool was reading a border-color, without a border style being defined. There is no reason to display this attribute without a border-style defined.
  • Text Shadow Attribute - Added the CSS attribute of text-shadow to the list.
  • Enhanced Support For Individual Word Styling - If you attempted to style one word differently within a text block by applying, for example, a different color or font weight, this would cause the styled word to break out of the text block. From a technical perspective, this occurred because we were setting <span> elements to display: inline-block;. This was done so we could accurately measure their height, width, and position. Now for these elements, we won't show a height, width, or position because it conveys no information. We instead select the parent container which is typically a <p> tag.
  • Disable Artboard Concept - The redline tool attempts to mimic the concept of an artboard used in many other tools. This is represented as a floating, semi-opaque, centered board. Some users have very large documents or do not prefer this concept.

Version 3.1.1

  • Migrated from Gulp to npm for all build and development tasks
  • Updated dependencies
  • Added the CSS attributes of letter-spacing and text-transform
  • Added postcss for legacy browser support

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.