Code Monkey home page Code Monkey logo

ngx-onboarding's People

Contributors

alberst avatar azure-pipelines[bot] avatar dependabot[bot] avatar michaelkirchner avatar miller45 avatar sdohle avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

ngx-onboarding's Issues

Fix typos

CONTRIBUTING.md

  • Missing u in reqest in If you want to contribute send us a pull reqest.

I18N.md

  • Should be probably Then instead of Than in Than you have to provide the key value pairs for the translations

  • Typo: minimum instead of minimium in the argument has the minimium properties. Or even better: the EventEmitter argument has one required property lang: string

Position of buttons customizable

The 'Got it' and 'Turn off' buttons should be positionable.
Reason: if you want to show an onboarding item for an element in the down right corner the buttons conflict with the onboarding element.

White background of the spotlight

When I use the spotlight on one of my elements, the element becomes invisible (the whole spotlight is just plain white).
image
With onboarding closed:
image

After adding this to styles, everything works as expected for me:
.onboarding-spotlight { background: transparent !important; }

Broken E2E test

Sample App E2E Test is broken:

  1. workspace-project App should show onboarding overlay initially and hide it if "Turn Off" button is clicked
  • Failed: Wait timed out after 10009ms
(...)
          at AppPage.waitAndCountOnboardingHeader (/home/steffen/git/github/ngx-onboarding/e2e/src/app.po.ts:25:17)
          at UserContext.<anonymous> (/home/steffen/git/github/ngx-onboarding/e2e/src/app.e2e-spec.ts:23:21)
(...)

Angular 9 (ivy) compatibility

We just updated to Angular 9 RC and get the following error when compiling our solution (works fine on Angular8):

chunk {mainERROR in Failed to compile entry-point @rosen-group/ngx-onboarding due to compilation errors:
} main.js, main.js.map (main) 2.06 kB [initial]node_modules/@rosen-group/ngx-onboarding/fesm5/rosen-group-ngx-onboarding.js(2047,30): error TS-991010: Value at position 1 in the NgModule.imports of OnboardingModule is not a reference: [object Object]
 [rendered]


Are there any plans to update to Angular 9? Would be very happy :)

Setup CI/CD workflow

Setup CI/CD workflow:

  • build & tests for PR
  • CI build & tests
  • deploy package on npm
  • optional: run e2e tests

Consider removing lodash-es usage

I wanted to ask if there was a specific reason to use lodash-es in the project? It uses the following utilities (search result), which either have native equivalents, or easy replacements:

  • each (actually forEach) - Array#forEach can be used
  • filter - Array#filter can be used
  • find - Array#find can be used
  • some - Array#some can be used
  • isEmpty - no native method, but where being used, simple falsy checks might be good enough

Angular 15 Dependency Issue

I'm getting an dependency error when attempting to install this package.

I'm running angular 15+

npm ERR! Found: [email protected]
npm ERR! node_modules/rxjs
npm ERR!   rxjs@"^7.8.0" from the root project
npm ERR!   peer rxjs@"^6.5.3 || ^7.4.0" from @angular/[email protected]
npm ERR!   node_modules/@angular/core
npm ERR!     @angular/core@"^15.1.0" from the root project
npm ERR!     peer @angular/core@"^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0" from @rosen-group/[email protected]
npm ERR!     node_modules/@rosen-group/ngx-onboarding
npm ERR!       @rosen-group/ngx-onboarding@"*" from the root project
npm ERR!     7 more (@angular/animations, @angular/cdk, @angular/common, ...)
npm ERR!   4 more (@angular/cdk, @angular/common, @angular/forms, @angular/material)
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer rxjs@"^6.5.4" from @rosen-group/[email protected]
npm ERR! node_modules/@rosen-group/ngx-onboarding
npm ERR!   @rosen-group/ngx-onboarding@"*" from the root project

return type of save methods should be void

abstract save(seenSelectors: Array<string>): Observable<boolean>;

abstract save(enabled: boolean): Observable<boolean>;

save methods are never subscribed

private saveSeenSelectors() {
this.loadAndSaveSeenSelectorsService.save(this.seenSelectors);
}

private saveEnabledStatus() {
this.loadAndSaveEnabledStatusService.save(this.enabled);
}

onboarding.service.spec.ts has lint issues

Just ran the the npm lint job and this is what showed up:

ERROR: ngx-onboarding/projects/ngx-onboarding/src/lib/services/onboarding.service.spec.ts[32, 44]: variable 'getOnboardingItems' used before declaration
ERROR: ngx-onboarding/projects/ngx-onboarding/src/lib/services/onboarding.service.spec.ts[47, 28]: variable 'getHtmlElements' used before declaration
ERROR: ngx-onboarding/projects/ngx-onboarding/src/lib/services/onboarding.service.spec.ts[50, 46]: variable 'getOnboardingItems' used before declaration
ERROR: ngx-onboarding/projects/ngx-onboarding/src/lib/services/onboarding.service.spec.ts[64, 55]: variable 'getOnboardingItems' used before declaration
ERROR: ngx-onboarding/projects/ngx-onboarding/src/lib/services/onboarding.service.spec.ts[130, 40]: variable 'getOnboardingItems' used before declaration

We should adjust the tslint rules or push the constant to the top of the spec file...
Anyway, @SDohle why is our pull request build not running the lint job?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.