Skip to content
This repository has been archived by the owner on Feb 17, 2021. It is now read-only.

Cleanup deprecated configuration options #144

Open
timlindvall opened this issue Feb 12, 2015 · 3 comments
Open

Cleanup deprecated configuration options #144

timlindvall opened this issue Feb 12, 2015 · 3 comments

Comments

@timlindvall
Copy link
Collaborator

We should start removing config options that have been formally deprecated or don't appear to be useful anymore. I propose the following...

Formally Deprecated

  • step.orientation has been replaced with step.placement (since 0.1.0)
  • step.padding is no longer necessary for placement calculations (since 0.2.0)

Undocumented, would like to remove

Far future (not part of this first pass)

@kate2753
Copy link
Contributor

  • arrowWidth has been deprecated in Deprecated arrowWidth config and added unit tests for xOffset and yOffset #213 Hopscotch automatically determines width of the arrow, no need for this to be explicitly configured by the user.
  • fixedElement has been deprecated in First stab at callout and arrow positioning logic. #212 Hopscotch will consider target as fixed if target element has position fixed or any of its parent elements have fixed position.
  • bubbleWidth is deprecated in favor of width. Tour level option was called bubbleWidth while step level option was simply called width. We are making naming more consistent and consolidating on width. Default width value remains 280px. 63114c3
  • orientation is deprecated in favor of placement. We now only support placement option, orientation will be ignored. 465371d

@kate2753
Copy link
Contributor

Deprecation candidates

  • showSkip [BOOLEAN] - if true, 'Next' button reads 'Skip'. Default: false. Next button's label can be configured via i18n.nextBtn config option instead. If more complex changes are required, custom callout template can be used.
  • showCTAButton, ctaLabel, onCTA. These config options are for call-to-action button. We could potentially support this via custom templates, but would need to provide an easy way to attach event handlers to custom buttons. Maybe something along the lines of jQuery .on delegate support.
  • delay- number in milliseconds to wait before showing step. Default: 0. Could this be delegated to LESS\CSS? Or could this potentially be a plugin which handles smooth fade in\fade out animations?
  • bubblePadding and padding [NUMBER] - Default bubble padding. Default: 15. This should be configured in LESS\CSS. Callout placement logic should be able to determine bubble padding and given that correctly position the callout.
  • smoothScroll, scrollDuration and scrollTopMargin- config options for scrolling to the target. This is a good candidate for a plugin.
  • zindex [INT] - sets the z-index of the bubble. Should this be set in LESS\CSS?

@timlindvall
Copy link
Collaborator Author

General notes:

  • We should find a better solution for buttons. The current config set around skip and CTA is convoluted.
  • Delay could be solved for by callbacks if callbacks supported deferring on a promise.
  • We've already cleaned up padding and width configs. Hurray!
  • Smooth scroll seems relevant to the majority of use cases for Hopscotch. IMO, I'm torn between keeping it as part of core or spinning it into a plugin that we then ship as part of a "Hopscotch Starter Pack" of sorts.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants