Skip to content

Commit

Permalink
feat: repo change
Browse files Browse the repository at this point in the history
  • Loading branch information
shhdharmen committed Feb 29, 2024
1 parent d5fab06 commit 9f499c0
Show file tree
Hide file tree
Showing 70 changed files with 630 additions and 599 deletions.
2 changes: 1 addition & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"projectName": "cmdk",
"projectOwner": "@ngneat",
"projectOwner": "@ngxpert",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
Expand Down
2 changes: 1 addition & 1 deletion .releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
[
"@semantic-release/npm",
{
"pkgRoot": "./dist/ngneat/cmdk",
"pkgRoot": "./dist/ngxpert/cmdk",
"tarballDir": "dist"
}
],
Expand Down
128 changes: 64 additions & 64 deletions CHANGELOG.md

Large diffs are not rendered by default.

56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
<p align="center">
<img width="20%" height="20%" src="./src/assets/ngneat%20cdk.svg">
<img width="20%" height="20%" src="./src/assets/ngxpert%20cdk.svg">
</p>

<br />

[![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg?style=flat-square)](./LICENSE)
[![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](./CONTRIBUTING.md)
[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/ngneat/cmdk/compare)
[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/ngxpert/cmdk/compare)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
[![ngneat-lib](https://img.shields.io/badge/made%20with-%40ngneat%2Flib-ad1fe3?logo=angular)](https://github.com/ngneat/lib)
[![ngxpert-lib](https://img.shields.io/badge/made%20with-%40ngxpert%2Flib-ad1fe3?logo=angular)](https://github.com/ngxpert/lib)
[![spectator](https://img.shields.io/badge/tested%20with-spectator-2196F3.svg?style=flat-square)]()
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![npm](https://img.shields.io/npm/v/@ngneat/cmdk)](https://www.npmjs.com/package/@ngneat/cmdk)
[![npm](https://img.shields.io/npm/v/@ngxpert/cmdk)](https://www.npmjs.com/package/@ngxpert/cmdk)

> Fast, composable, unstyled command menu for Angular. Directly inspired from [pacocoursey/cmdk](https://github.com/pacocoursey/cmdk)
# @ngneat/cmdk
# @ngxpert/cmdk

@ngneat/cmdk is a command menu Angular component that can also be used as an accessible combobox. You render items, it filters and sorts them automatically. @ngneat/cmdk supports a fully composable API, so you can wrap items in other components or even as static HTML.
@ngxpert/cmdk is a command menu Angular component that can also be used as an accessible combobox. You render items, it filters and sorts them automatically. @ngxpert/cmdk supports a fully composable API, so you can wrap items in other components or even as static HTML.

Demo and examples: [ngneat.github.io/cmdk](https://ngneat.github.io/cmdk)
Demo and examples: [ngxpert.github.io/cmdk](https://ngxpert.github.io/cmdk)

## Features

Expand All @@ -32,7 +32,7 @@ Demo and examples: [ngneat.github.io/cmdk](https://ngneat.github.io/cmdk)

## Compatibility with Angular Versions

| @ngneat/cmdk | Angular |
| @ngxpert/cmdk | Angular |
| -- | -- |
| 1.x | <16 |
| 2.x | >=16 |
Expand All @@ -42,7 +42,7 @@ Demo and examples: [ngneat.github.io/cmdk](https://ngneat.github.io/cmdk)
### Angular CLI

```bash
ng add @ngneat/cmdk
ng add @ngxpert/cmdk
```

### NPM
Expand All @@ -51,18 +51,18 @@ ng add @ngneat/cmdk
# For Angular version < 16

## First, install dependencies
npm install @ngneat/overview@4 @ngneat/until-destroy@9 @angular/cdk@15
npm install @ngxpert/overview@4 @ngxpert/until-destroy@9 @angular/cdk@15

## Then library
npm install @ngneat/cmdk@1
npm install @ngxpert/cmdk@1

# For Angular version >= 16

## First, install dependencies
npm install @ngneat/overview@5 @ngneat/until-destroy@10 @angular/cdk@16
npm install @ngxpert/overview@5 @ngxpert/until-destroy@10 @angular/cdk@16

## Then library
npm install @ngneat/cmdk@2
npm install @ngxpert/cmdk@2
```

### Yarn
Expand All @@ -75,10 +75,10 @@ Same as `npm`, just instead of `npm install`, write `yarn add`.

#### 1.1 Module Setup

> This is taken care with ng add @ngneat/cmdk
> This is taken care with ng add @ngxpert/cmdk
```ts
import { CmdkModule } from '@ngneat/cmdk';
import { CmdkModule } from '@ngxpert/cmdk';

@NgModule({
imports: [
Expand All @@ -100,7 +100,7 @@ import {
ItemDirective,
ListComponent,
EmptyDirective
} from '@ngneat/cmdk';
} from '@ngxpert/cmdk';

@Component({
selector: 'app-root',
Expand Down Expand Up @@ -342,7 +342,7 @@ getItems() {

### Use inside Popover

We recommend using the [Angular CDK Overlay](https://material.angular.io/cdk/overlay/overview). @ngneat/cdk relies on the Angular CDK, so this will reduce your bundle size a bit due to shared dependencies.
We recommend using the [Angular CDK Overlay](https://material.angular.io/cdk/overlay/overview). @ngxpert/cdk relies on the Angular CDK, so this will reduce your bundle size a bit due to shared dependencies.

First, configure the trigger component:

Expand Down Expand Up @@ -424,19 +424,19 @@ ngAfterViewInit() {

### Drop in stylesheets

You can find global stylesheets to drop in as a starting point for styling. See [ngneat/cmdk/styles](./projects/ngneat/cmdk/styles) for examples.
You can find global stylesheets to drop in as a starting point for styling. See [ngxpert/cmdk/styles](./projects/ngxpert/cmdk/styles) for examples.

You can include the `SCSS` stylesheet in your application's style file:

```scss
// Global is needed for any theme
@use "~@ngneat/cmdk/styles/scss/globals";
@use "~@ngxpert/cmdk/styles/scss/globals";

// Then add theme
@use "~@ngneat/cmdk/styles/scss/framer";
// @use "~@ngneat/cmdk/styles/scss/vercel";
// @use "~@ngneat/cmdk/styles/scss/linear";
// @use "~@ngneat/cmdk/styles/scss/raycast";
@use "~@ngxpert/cmdk/styles/scss/framer";
// @use "~@ngxpert/cmdk/styles/scss/vercel";
// @use "~@ngxpert/cmdk/styles/scss/linear";
// @use "~@ngxpert/cmdk/styles/scss/raycast";
```

or, use pre-built `CSS` file in `angular.json`
Expand All @@ -445,8 +445,8 @@ or, use pre-built `CSS` file in `angular.json`
// ...
"styles": [
"...",
"node_modules/@ngneat/cmdk/styles/globals.css"
"node_modules/@ngneat/cmdk/styles/framer.css"
"node_modules/@ngxpert/cmdk/styles/globals.css"
"node_modules/@ngxpert/cmdk/styles/framer.css"
],
// ...
```
Expand Down Expand Up @@ -474,9 +474,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/shhdharmen"><img src="https://avatars.githubusercontent.com/u/6831283?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dharmen Shah</b></sub></a><br /><a href="#a11y-shhdharmen" title="Accessibility">️️️️♿️</a> <a href="https://github.com/@ngneat/cmdk/commits?author=shhdharmen" title="Code">💻</a> <a href="#content-shhdharmen" title="Content">🖋</a> <a href="#design-shhdharmen" title="Design">🎨</a> <a href="https://github.com/@ngneat/cmdk/commits?author=shhdharmen" title="Documentation">📖</a> <a href="#example-shhdharmen" title="Examples">💡</a> <a href="#ideas-shhdharmen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-shhdharmen" title="Maintenance">🚧</a> <a href="#platform-shhdharmen" title="Packaging/porting to new platform">📦</a> <a href="#projectManagement-shhdharmen" title="Project Management">📆</a> <a href="#research-shhdharmen" title="Research">🔬</a></td>
<td align="center"><a href="https://www.netbasal.com/"><img src="https://avatars.githubusercontent.com/u/6745730?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Netanel Basal</b></sub></a><br /><a href="#question-NetanelBasal" title="Answering Questions">💬</a> <a href="#business-NetanelBasal" title="Business development">💼</a> <a href="#fundingFinding-NetanelBasal" title="Funding Finding">🔍</a> <a href="#ideas-NetanelBasal" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-NetanelBasal" title="Maintenance">🚧</a> <a href="#mentoring-NetanelBasal" title="Mentoring">🧑‍🏫</a> <a href="#projectManagement-NetanelBasal" title="Project Management">📆</a> <a href="#research-NetanelBasal" title="Research">🔬</a> <a href="https://github.com/@ngneat/cmdk/pulls?q=is%3Apr+reviewed-by%3ANetanelBasal" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/pacocoursey"><img src="https://avatars.githubusercontent.com/u/34928425?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Paco</b></sub></a><br /><a href="#design-pacocoursey" title="Design">🎨</a> <a href="https://github.com/@ngneat/cmdk/commits?author=pacocoursey" title="Documentation">📖</a> <a href="#ideas-pacocoursey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-pacocoursey" title="Research">🔬</a></td>
<td align="center"><a href="https://github.com/shhdharmen"><img src="https://avatars.githubusercontent.com/u/6831283?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dharmen Shah</b></sub></a><br /><a href="#a11y-shhdharmen" title="Accessibility">️️️️♿️</a> <a href="https://github.com/@ngxpert/cmdk/commits?author=shhdharmen" title="Code">💻</a> <a href="#content-shhdharmen" title="Content">🖋</a> <a href="#design-shhdharmen" title="Design">🎨</a> <a href="https://github.com/@ngxpert/cmdk/commits?author=shhdharmen" title="Documentation">📖</a> <a href="#example-shhdharmen" title="Examples">💡</a> <a href="#ideas-shhdharmen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-shhdharmen" title="Maintenance">🚧</a> <a href="#platform-shhdharmen" title="Packaging/porting to new platform">📦</a> <a href="#projectManagement-shhdharmen" title="Project Management">📆</a> <a href="#research-shhdharmen" title="Research">🔬</a></td>
<td align="center"><a href="https://www.netbasal.com/"><img src="https://avatars.githubusercontent.com/u/6745730?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Netanel Basal</b></sub></a><br /><a href="#question-NetanelBasal" title="Answering Questions">💬</a> <a href="#business-NetanelBasal" title="Business development">💼</a> <a href="#fundingFinding-NetanelBasal" title="Funding Finding">🔍</a> <a href="#ideas-NetanelBasal" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-NetanelBasal" title="Maintenance">🚧</a> <a href="#mentoring-NetanelBasal" title="Mentoring">🧑‍🏫</a> <a href="#projectManagement-NetanelBasal" title="Project Management">📆</a> <a href="#research-NetanelBasal" title="Research">🔬</a> <a href="https://github.com/@ngxpert/cmdk/pulls?q=is%3Apr+reviewed-by%3ANetanelBasal" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/pacocoursey"><img src="https://avatars.githubusercontent.com/u/34928425?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Paco</b></sub></a><br /><a href="#design-pacocoursey" title="Design">🎨</a> <a href="https://github.com/@ngxpert/cmdk/commits?author=pacocoursey" title="Documentation">📖</a> <a href="#ideas-pacocoursey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-pacocoursey" title="Research">🔬</a></td>
</tr>
</table>

Expand Down
22 changes: 11 additions & 11 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,46 +102,46 @@
}
}
},
"@ngneat/cmdk": {
"@ngxpert/cmdk": {
"projectType": "library",
"schematics": {
"@schematics/angular:component": {
"style": "scss"
}
},
"root": "projects/ngneat/cmdk",
"sourceRoot": "projects/ngneat/cmdk/src",
"root": "projects/ngxpert/cmdk",
"sourceRoot": "projects/ngxpert/cmdk/src",
"prefix": "cmdk",
"architect": {
"build": {
"builder": "@angular-devkit/build-angular:ng-packagr",
"options": {
"project": "projects/ngneat/cmdk/ng-package.json"
"project": "projects/ngxpert/cmdk/ng-package.json"
},
"configurations": {
"production": {
"tsConfig": "projects/ngneat/cmdk/tsconfig.lib.prod.json"
"tsConfig": "projects/ngxpert/cmdk/tsconfig.lib.prod.json"
},
"development": {
"tsConfig": "projects/ngneat/cmdk/tsconfig.lib.json"
"tsConfig": "projects/ngxpert/cmdk/tsconfig.lib.json"
}
},
"defaultConfiguration": "production"
},
"test": {
"builder": "@angular-devkit/build-angular:karma",
"options": {
"main": "projects/ngneat/cmdk/src/test.ts",
"tsConfig": "projects/ngneat/cmdk/tsconfig.spec.json",
"karmaConfig": "projects/ngneat/cmdk/karma.conf.js"
"main": "projects/ngxpert/cmdk/src/test.ts",
"tsConfig": "projects/ngxpert/cmdk/tsconfig.spec.json",
"karmaConfig": "projects/ngxpert/cmdk/karma.conf.js"
}
},
"lint": {
"builder": "@angular-eslint/builder:lint",
"options": {
"lintFilePatterns": [
"projects/ngneat/cmdk/**/*.ts",
"projects/ngneat/cmdk/**/*.html"
"projects/ngxpert/cmdk/**/*.ts",
"projects/ngxpert/cmdk/**/*.html"
]
}
}
Expand Down
2 changes: 1 addition & 1 deletion cypress/basic.cy.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CmdkModule } from '@ngneat/cmdk';
import { CmdkModule } from '@ngxpert/cmdk';
import { createOutputSpy } from 'cypress/angular';

describe('basic behavior', () => {
Expand Down
Loading

0 comments on commit 9f499c0

Please sign in to comment.