ranndev / ui-guide Goto Github PK

The devDependency rollup was updated from 1.26.3 to 1.26.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rollup is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency cypress was updated from 3.6.0 to 3.6.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

cypress is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

A gif that shows the basic highlighting.

• Remove unnecessary .d.ts from dist.
• Only general single types declaration.

Is your feature request related to a problem? Please describe.
Currently, we have an autofocus highlight option, but that focus can't easily get away when clicking on other elements around the page. I'm suggesting a new option that can set the focus & trap it to the target element until we removed the highlight.

Describe the solution you'd like
Instead of accepting only boolean value in autofocus highlight option. I'd like to make it also possible to accept 'trap' string value to enable the said feature. And I'd like it to be enabled by default.

CodeFactor found an issue: Complex Method

It's currently on:
src\ui-guide.ts:100-183
Commit 2d408e2

Important to mention:

• Development setup
• How to create a your own theme.

Is your feature request related to a problem? Please describe.
This is for making it easy to do basic tasks on highlighted element, specially for adding temporary events (like asking user for a single click, checking a checkbox, type on input, etc.)

Describe the solution you'd like
We can imagine the usage of utility functions as:

uiguide.highlight('#target-element').then(uiguide.ask.click(3))
uiguide.highlight('#target-element').then(uiguide.ask.type('Hello'))

Describe the bug
The event has a name onElementsReady but the Popper instance is also accessible on the argument 🤔

onElementsReady: (elements) => {
  elements.popper // Is it also element?! Nah
}

Expected behavior
popper instance should not be included on the event arguments.

Describe the bug
Tried configuring the uiguide to autofocus: false but highlighted element still automatically gains the focus.

To Reproduce
Try it in this pen https://codepen.io/rannie-peralta/pen/oNgvwQV

Expected behavior:

Prettier should format the .ts file successfully.

A web app where users can try & play with the ui-guide library.

• Code & Run
• Change the playground html
• Change theme

Currently, we only have one default theme which is only for light background.

Is your feature request related to a problem? Please describe.
The default import of package is somewhat misleading. It is returning a function that does nothing.

Describe the solution you'd like
Return the instance instead make its functions non-static.

class UIGuide {
  highlight() {}
}

return new UIGuide()

The devDependency rollup was updated from 1.27.6 to 1.27.7.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rollup is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

• Types declaration must be in a single .d.ts file

Describe the bug
While I'm working on #64 , found out that popup doesn't have an animation. Popup shown while the highlight isn't visible yet, which is not cool.

To Reproduce
Check out the https://codepen.io/rannie-peralta/pen/oNgvwQV

Expected behavior
Should animate the showing of popup