From a3bc2eb502453e45fbf56fe8bea2449f6c946ba7 Mon Sep 17 00:00:00 2001 From: NAVENKUMAR D Date: Tue, 22 Aug 2023 00:42:39 +0530 Subject: [PATCH 1/2] updated README --- projects/we-select/README.md | 49 +++++++++++++++++++++++++++++---- projects/we-select/package.json | 2 +- 2 files changed, 44 insertions(+), 7 deletions(-) diff --git a/projects/we-select/README.md b/projects/we-select/README.md index c013449..f00aa60 100644 --- a/projects/we-select/README.md +++ b/projects/we-select/README.md @@ -1,10 +1,50 @@ # WeSelect This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.0. +## we-multi-col-select +![sample usage for multi-col-select](/images/image.png) + +### Usage +- Add `WeSelectModule` to the imports array in your module and you can start using the `we-multi-col-select`. + +``` + + +``` + +### Inputs + +options.ts +``` +export interface Option{ + value: any; + displayText: string; +} +``` + +optionsContainerWidth - The width of the optionsContainer in pixels. The default width is `500px`. + +columns - number of options to be displayed in each row. The entire width of the optionsContainer is equally distributed among the columns. The default value is set to `1`. + +disabled - disabled takes a boolean value. The default value is set to `false`. + +selectedOption - It allows you to pass a `Option` which should be selected by default. + +### Outputs + +onSelectChange - onSelectChange output event is emitted when ever the selected option changes. It emits the value property from the selectedOption. + ## Code scaffolding -Run `ng generate component component-name --project we-select` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project we-select`. +Run `ng generate component component-name --project we` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project we`. > Note: Don't forget to add `--project we-select` or else it will be added to the default project in your `angular.json` file. ## Build @@ -15,10 +55,7 @@ Run `ng build we-select` to build the project. The build artifacts will be store After building your library with `ng build we-select`, go to the dist folder `cd dist/we-select` and run `npm publish`. -## Running unit tests - -Run `ng test we-select` to execute the unit tests via [Karma](https://karma-runner.github.io). +## Contributions -## Further help +Pull requests are most welcome. -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page. diff --git a/projects/we-select/package.json b/projects/we-select/package.json index ad729d8..e38cbd0 100644 --- a/projects/we-select/package.json +++ b/projects/we-select/package.json @@ -1,6 +1,6 @@ { "name": "we-select", - "version": "2.1.11", + "version": "2.1.12", "peerDependencies": { "@angular/common": "^14.2.0", "@angular/core": "^14.2.0" From 5ae24a8ec30ace9784e15f58cfa39d6b3a6b9412 Mon Sep 17 00:00:00 2001 From: NAVENKUMAR D Date: Tue, 22 Aug 2023 00:46:10 +0530 Subject: [PATCH 2/2] updated README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c332354..ebde06f 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ onSelectChange - onSelectChange output event is emitted when ever the selected o ## Code scaffolding -Run `ng generate component component-name --project we` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project we`. +Run `ng generate component component-name --project we-select` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project we-select`. > Note: Don't forget to add `--project we-select` or else it will be added to the default project in your `angular.json` file. ## Build