dropkiq

Dropkiq

Dropkiq simplifies the creation of Liquid expressions. Quickly build your dynamic content with the simplest Liquid template editor.

• Immediate Feedback: No more guesswork. Know exactly how your expressions will evaluate in real time.
• No More Typos: To err is human. Identify mistakes as they happen and take corrective measures.
• Visibility of Options: Data at your fingertips. See what data is available without asking your development team.

Check it out at https://www.dropkiq.com!

DropkiqUI works with the Dropkiq Engine in order to provide inline Liquid suggestions as users write Liquid documents.

The Dropkiq Engine can be found here: https://www.npmjs.com/package/dropkiq. The engine is responsible for processing the text, caret position, and schema of the application to make suggestions as the user types. The DropkiqUI (contained in this repository) is responsible for rendering the UI so that users may see those suggestions.

The DropkiqUI has been tested in all major browsers and works with standard text input, textarea, and contenteditable fields.

Installation

DropkiqUI is available via npm: https://www.npmjs.com/package/dropkiq-ui

With NPM:

npm install dropkiq

With Yarn:

yarn install dropkiq

Example Installation instructions for Rails (Assuming you're using Webpacker: https://github.com/rails/webpacker):

1. Import the DropkiqEngine library from dropkiq

const { DropkiqEngine } = require('dropkiq')

1. Create a new instance of the Dropkiq auto completion library:

let dropkiqEngine = new DropkiqEngine("", 0, schema, context, scope, this.licenseKey);

1. As the text and caret position changes, update to get new results:

this.result = this.dropkiqEngine.update("{{}}", 2);

Development

After checking out the repo, run yarn to install dependencies. Then, run yarn jest to run the tests.

To generate a new build, run gulp.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/akdarrah/dropkiq-ui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The Dropkiq License Key can be purchased at https://www.dropkiq.com/.

Copyright (c) DROPKIQ LLC

DROPKIQ is a software distributed by DROPKIQ LLC, a United States LLC, based in Indiana, Indianapolis, at 6259 N. College Avenue, registered under the Indiana Business Flexibility Act, as amended (Indiana Code Sections 231811 et seq.).

This software is protected by applicable copyright laws, including international treaties, and dual-licensed – depending on whether your use is intended for or may result in commercial advantage or monetary compensation (commercial purposes), or not.

By installing, copying, or otherwise using this software, you agree to be bound by the terms included in the Terms of Use, available at https://app.dropkiq.com/terms.

DROPKIQ LLC PROVIDES THIS SOFTWARE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND. IN NO EVENT AND UNDER NO LEGAL THEORY, SHALL DROPKIQ LLC BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER ARISING FROM USE OR INABILITY TO USE THIS SOFTWARE.