Skip to content

Multi-keywords highlighter library for angular applications. This workspace could also be used as reference for build an angular library with integration of NX, Angular, Verdaccio, Playwright, BDD

License

Notifications You must be signed in to change notification settings

dylannnn/ngx-multi-keywords-highlighter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NgxMultiKeywordsHighlighterWorkspace

ngx-multi-keywords-highlighter-e2e

Publish NGX Multi Keywords Highlighter

How to use

Add "node_modules/@amfrontender/ngx-multi-keywords-highlighter/themes/index.scss" or "node_modules/@amfrontender/ngx-multi-keywords-highlighter/themes/themes.scss" to your angular.json or project.json if you use NX to the build options of styles.

Import the NgxMultiKeywordsHighlighterModule to your app.module.ts

import { LABEL_POSITION, MATERIAL_COLOR, NgxMultiKeywordsHighlighterModule } from '@amfrontender/ngx-multi-keywords-highlighter';

Add NgxMultiKeywordsHighlighterModule config to the imports

@NgModule({
  declarations: [...],
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    NgxMultiKeywordsHighlighterModule.forRoot({
      themeColor: MATERIAL_COLOR.PRIMARY,
      enableToggleLabel: true,
      toggleLabelPosition: LABEL_POSITION.BEFORE,
      enableHighlighterTooltip: 'Turn on/off highlighter',
      minWidth: 320,
      appRoot: 'mkh-root',
    }),
    ...
  ],
  providers: [...],
  bootstrap: [...],
})
export class AppModule {}

Add selector to the html

<mkh-multi-keywords-highlighter class="custom-lib"></mkh-multi-keywords-highlighter>

For more advanced usages, please check the storybook or the demo app

Semantic Commits

Type Notes
build Changes that affect the build system or external dependencies
chore Changes to the build process, release or auxiliary tools and libraries such as documentation generation
ci Changes to our CI configuration files and scripts
docs Documentation only changes
feat A new feature
fix A bug fix
perf A code change that improves performance
refactor A refactoring
revert A revert commit
style UI/UX CHANGES
test Adding missing tests

Branches

Feature Branches

Release locally with Vadaccio to test

docker compose up --build -d

CI Tasks

  • Lint all
  • Unit Test all
  • E2E Test all
  • Chromatic Test (TBD)
  • Build

Beta Branch

Beta branch is for pre-release

CI Tasks

  • Lint all
  • Unit Test all
  • E2E Test all
  • Chromatic Test (TBD)
  • Build

Next Branch

Any new feature, major version update branch

CI Tasks

  • Lint all
  • Unit Test all
  • E2E Test all
  • Chromatic Test (TBD)
  • Build

Develop Branch

Before release, for testing

CI Tasks

  • Lint all
  • Unit Test all
  • E2E Test all
  • Chromatic Test (TBD)
  • Build

Main Branch

Production ready branch

CI Tasks

  • Lint all
  • Unit Test all
  • E2E Test all
  • Chromatic Test (TBD)
  • Build

About

Multi-keywords highlighter library for angular applications. This workspace could also be used as reference for build an angular library with integration of NX, Angular, Verdaccio, Playwright, BDD

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published