diff --git a/.babelrc b/.babelrc
new file mode 100644
index 00000000..4fedfa53
--- /dev/null
+++ b/.babelrc
@@ -0,0 +1,17 @@
+{
+ "presets": [
+ ["vue-app", {
+ "modules": false
+ }]
+ ],
+ "plugins": [
+ ["module-resolver", {
+ "extensions": [".js", ".vue", ".json"]
+ }]
+ ],
+ "env": {
+ "test": {
+ "plugins": ["dynamic-import-node"]
+ }
+ }
+}
\ No newline at end of file
diff --git a/.commitlintrc.json b/.commitlintrc.json
new file mode 100644
index 00000000..0df1d253
--- /dev/null
+++ b/.commitlintrc.json
@@ -0,0 +1,5 @@
+{
+ "extends": [
+ "@commitlint/config-conventional"
+ ]
+}
diff --git a/.editorconfig b/.editorconfig
index ebe51d3b..4039ff11 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -1,12 +1,12 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
-# top-most EditorConfig file
root = true
[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
trim_trailing_whitespace = false
-insert_final_newline = false
\ No newline at end of file
diff --git a/.eslintignore b/.eslintignore
new file mode 100644
index 00000000..502f12e7
--- /dev/null
+++ b/.eslintignore
@@ -0,0 +1,5 @@
+.github/
+_book/
+docs/
+coverage/
+dist/
\ No newline at end of file
diff --git a/.eslintrc.js b/.eslintrc.js
new file mode 100644
index 00000000..64977756
--- /dev/null
+++ b/.eslintrc.js
@@ -0,0 +1,55 @@
+// https://eslint.org/docs/user-guide/configuring
+
+module.exports = {
+ root: true,
+ parserOptions: {
+ parser: 'babel-eslint',
+ ecmaVersion: 2017,
+ sourceType: 'module'
+ },
+ plugins: ['html', 'vue'],
+ extends: [
+ 'eslint:recommended',
+ 'plugin:vue/recommended',
+ 'plugin:import/errors',
+ 'plugin:import/warnings'
+ ],
+ env: {
+ browser: true,
+ node: true,
+ commonjs: true,
+ es6: true,
+ jest: true
+ },
+ rules: {
+ // allow async-await
+ 'generator-star-spacing': 'off',
+ // don't require .vue extension when importing
+ 'import/extensions': ['error', 'always', {
+ 'js': 'never',
+ 'vue': 'never'
+ }],
+ // disallow reassignment of function parameters
+ // disallow parameter object manipulation except for specific exclusions
+ 'no-param-reassign': ['error', {
+ props: true,
+ ignorePropertyModificationsFor: [
+ 'state', // for vuex state
+ 'acc', // for reduce accumulators
+ 'e' // for e.returnvalue
+ ]
+ }],
+ // allow optionalDependencies
+ 'import/no-extraneous-dependencies': ['error', {
+ optionalDependencies: ['test/index.js']
+ }],
+ // allow debugger during development
+ 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
+ },
+ "settings": {
+ // resolve using plugin babel module resolver
+ "import/resolver": {
+ "babel-module": {}
+ }
+ }
+}
\ No newline at end of file
diff --git a/.gitattributes b/.gitattributes
deleted file mode 100644
index 205021e4..00000000
--- a/.gitattributes
+++ /dev/null
@@ -1,2 +0,0 @@
-# Enforce Unix newlines
-* text=auto eol=lf
diff --git a/.github/.stale.yml b/.github/.stale.yml
deleted file mode 100644
index c2b8bcee..00000000
--- a/.github/.stale.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 360
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
-# Issues with these labels will never be considered stale
-exemptLabels:
- - pinned
- - security
-# Label to use when marking an issue as stale
-staleLabel: wontfix
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
- This issue has been automatically marked as stale because it has not had
- recent activity. It will be closed if no further activity occurs. Thank you
- for your contributions.
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false
\ No newline at end of file
diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md
index 261c7ca2..fc436da5 100644
--- a/.github/COMMIT_CONVENTION.md
+++ b/.github/COMMIT_CONVENTION.md
@@ -10,10 +10,10 @@ Appears under "Features" header, `compiler` subheader:
feat(compiler): add 'comments' option
```
-Appears under "Bug Fixes" header, `sidebar` subheader, with a link to issue #28:
+Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue #28:
```
-fix(sidebar): handle events on blur
+fix(v-model): handle events on blur
close #28
```
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 77fd8019..37d6ae2a 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,178 +1,34 @@
-# Contributing to CoreUI
+# Contributing
-Looking to contribute something to CoreUI? **Here's how you can help.**
+## Usage
-Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
+```bash
+# Install dependencies
+npm install
-Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing
-patches and features.
+# Build
+npm run build
-## Using the issue tracker
+# Run all tests with lint/jest
+npm run test
-The [issue tracker](https://github.com/coreui/coreui-vue/issues) is
-the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
-and [submitting pull requests](#pull-requests), but please respect the following
-restrictions:
+# Run test in watch mode
+npm run test:watch
-* Please **do not** use the issue tracker for personal support requests.
+# Update test snapshot
+npm run test:update
-* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
- Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
- instead.
+# Run linter
+npm run lint
-## Bug reports
+# Run linter with auto fix
+npm run lint:fix
+```
+## Workflow
-A bug is a _demonstrable problem_ that is caused by the code in the repository.
-Good bug reports are extremely helpful, so thanks!
-
-Guidelines for bug reports:
-
-0. **Validate and lint your code** — to ensure your problem isn't caused by a simple error in your own code.
-
-1. **Use the GitHub issue search** — check if the issue has already been reported.
-
-2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.
-
-3. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example. [This JS Bin](http://jsbin.com/lefey/1/edit?html,output) is a helpful template.
-
-
-A good bug report shouldn't leave others needing to chase you up for more
-information. Please try to be as detailed as possible in your report. What is
-your environment? What steps will reproduce the issue? What browser(s) and OS
-experience the problem? Do other browsers show the bug differently? What
-would you expect to be the outcome? All these details will help people to fix
-any potential bugs.
-
-Example:
-
-> Short and descriptive example bug report title
->
-> A summary of the issue and the browser/OS environment in which it occurs. If
-> suitable, include the steps required to reproduce the bug.
->
-> 1. This is the first step
-> 2. This is the second step
-> 3. Further steps, etc.
->
-> `` - a link to the reduced test case
->
-> Any other information you want to share that is relevant to the issue being
-> reported. This might include the lines of code that you have identified as
-> causing the bug, and potential solutions (and your opinions on their
-> merits).
-
-## Feature requests
-
-Feature requests are welcome. Before opening a feature request, please take a
-moment to find out whether your idea fits with the scope and aims of the
-project. It's up to *you* to make a strong case to convince the project's
-developers of the merits of this feature. Please provide as much detail
-and context as possible.
-
-
-## Pull requests
-
-Good pull requests—patches, improvements, new features—are a fantastic
-help. They should remain focused in scope and avoid containing unrelated
-commits.
-
-**Please ask first** before embarking on any significant pull request (e.g.
-implementing features, refactoring code, porting to a different language),
-otherwise you risk spending a lot of time working on something that the
-project's developers might not want to merge into the project.
-
-Adhering to the following process is the best way to get your work
-included in the project:
-
-1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
- and configure the remotes:
-
- ```bash
- # Clone your fork of the repo into the current directory
- git clone https://github.com//coreui-react.git
- # Navigate to the newly cloned directory
- cd coreui
- # Assign the original repo to a remote called "upstream"
- git remote add upstream https://github.com/coreui/coreui-vue.git
- ```
-
-2. If you cloned a while ago, get the latest changes from upstream:
-
- ```bash
- git checkout master
- git pull upstream master
- ```
-
-3. Create a new topic branch (off the main project development branch) to
- contain your feature, change, or fix:
-
- ```bash
- git checkout -b
- ```
-
-4. Commit your changes in logical chunks. Please adhere to these [git commit
- message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
- or your code is unlikely to be merged into the main project. Use Git's
- [interactive rebase](https://help.github.com/articles/interactive-rebase)
- feature to tidy up your commits before making them public.
-
-5. Locally merge (or rebase) the upstream development branch into your topic branch:
-
- ```bash
- git pull [--rebase] upstream master
- ```
-
-6. Push your topic branch up to your fork:
-
- ```bash
- git push origin
- ```
-
-7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
- with a clear title and description against the `master` branch.
-
-**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
-license your work under the terms of the [MIT License](LICENSE).
-
-### Semantic Git commit messages
-
-Inspired by Sparkbox's awesome article on
-[semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages).
-Please use following commit message format.
-
-* chore (updating npm tasks etc; no production code change) -> ```git test -m 'chore: commit-message-here'```
-* docs (changes to documentation) -> ```git commit -m 'docs: commit-message-here'```
-* feat (new feature) -> ```git commit -m 'feat: commit-message-here'```
-* fix (bug fix) -> ```git commit -m 'fix: commit-message-here'```
-* refactor (refactoring production code) -> ```git commit -m 'refactor: commit-message-here'```
-* style (formatting, missing semi colons, etc; no code change) -> ```git commit -m 'style: commit-message-here'```
-* test (adding missing tests, refactoring tests; no production code change) -> ```git test -m 'refactor: commit-message-here'```
-
-## Code guidelines
-
-### HTML
-
-[Adhere to the Code Guide.](http://codeguide.co/#html)
-
-- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
-- Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via `file://`.
-- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.
-
-### CSS
-
-[Adhere to the Code Guide.](http://codeguide.co/#css)
-
-- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast).
-- Except in rare cases, don't remove default `:focus` styles (via e.g. `outline: none;`) without providing alternative styles. See [this A11Y Project post](http://a11yproject.com/posts/never-remove-css-outlines) for more details.
-
-### JS
-
-- No semicolons (in client-side JS)
-- 2 spaces (no tabs)
-- strict mode
-- "Attractive"
-- Don't use [jQuery event alias convenience methods](https://github.com/jquery/jquery/blob/master/src/event/alias.js) (such as `$().focus()`). Instead, use [`$().trigger(eventType, ...)`](http://api.jquery.com/trigger/) or [`$().on(eventType, ...)`](http://api.jquery.com/on/), depending on whether you're firing an event or listening for an event. (For example, `$().trigger('focus')` or `$().on('focus', function (event) { /* handle focus event */ })`) We do this to be compatible with custom builds of jQuery where the event aliases module has been excluded.
-
-## License
-
-By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).
\ No newline at end of file
+- Create a component in the src/components folder
+- Add tests in the src/components/\_\_tests\_\_ folder
+- Register this component in src/index.js
+- Run lint and tests before commiting anything
+- Commit using [Commit Convention](./COMMIT_CONVENTION.md)
+- PR on github
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
deleted file mode 100644
index 544d42d2..00000000
--- a/.github/FUNDING.yml
+++ /dev/null
@@ -1,4 +0,0 @@
-# These are supported funding model platforms
-
-custom: "https://coreui.io/pricing/?support=true"
-open_collective: coreui
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..db59f8ab
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,20 @@
+Before opening an issue:
+
+- [Search for duplicate or closed issues](https://github.com/coreui/coreui-vue/issues?utf8=%E2%9C%93&q=is%3Aissue)
+- Prepare a [reduced test case](https://css-tricks.com/reduced-test-cases/) for any bugs
+- Read the [contributing guidelines](./CONTRIBUTING.md)
+
+When asking general "how to" questions:
+
+- Please do not open an issue here
+
+When reporting a bug, include:
+
+- Operating system and version (Windows, Mac OS X, Android, iOS, etc...)
+- Browser and version (Chrome, Firefox, Safari, IE, MS Edge, Opera 15+, Android Browser)
+- Reduced test cases and potential fixes using [CodePen](https://codepen.io/) or [JS Bin](https://jsbin.com/)
+
+When suggesting a feature, include:
+
+- As much detail as possible for what we should add and why it's important to CoreUI Admin Template
+- Relevant links to prior art, screenshots, or live demos whenever possible
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 7600be55..00000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Bug report
-about: Tell us about a bug you may have identified in Bootstrap.
-title: ''
-labels: ''
-assignees: ''
-
----
-
-Before opening:
-
-- [Search for duplicate or closed issues](https://github.com/coreui/coreui-vue/issues?utf8=%E2%9C%93&q=is%3Aissue)
-- [Validate](https://html5.validator.nu/) any HTML to avoid common problems
-- Read the [contributing guidelines](https://github.com/coreui/coreui-vue/blob/main/.github/CONTRIBUTING.md)
-
-Bug reports must include:
-
-- Operating system and version (Windows, macOS, Android, iOS)
-- Browser and version (Chrome, Firefox, Safari, Microsoft Edge, Opera, Android Browser)
-- A [reduced test case](https://css-tricks.com/reduced-test-cases/) or suggested fix using [CodePen](https://codepen.io/) or [JS Bin](https://jsbin.com/)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 5b09443c..00000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for a new feature in CoreUI.
-title: ''
-labels: feature
-assignees: ''
-
----
-
-Before opening:
-
-- [Search for duplicate or closed issues](https://github.com/coreui/coreui-vue/issues?utf8=%E2%9C%93&q=is%3Aissue)
-- Read the [contributing guidelines](https://github.com/coreui/coreui-vue/blob/main/.github/CONTRIBUTING.md)
-
-Feature requests must include:
-
-- As much detail as possible for what we should add and why it's important to Bootstrap
-- Relevant links to prior art, screenshots, or live demos whenever possible
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..e3286a13
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,35 @@
+
+
+
+
+
+**What kind of change does this PR introduce?** (check at least one)
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update
+- [ ] Refactor
+- [ ] Build-related changes
+- [ ] Other, please describe:
+
+**Does this PR introduce a breaking change?** (check one)
+
+- [ ] Yes
+- [ ] No
+
+If yes, please describe the impact and migration path for existing applications:
+
+**The PR fulfills these requirements:**
+
+- [ ] It's submitted to the `develop` branch (or to a previous version branch), _not_ the `master` branch
+- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
+- [ ] All tests are passing
+- [ ] New/updated tests are included
+
+If adding a **new feature**, the PR's description includes:
+- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
+
+**Other information:**
diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
deleted file mode 100644
index 74584c95..00000000
--- a/.github/SUPPORT.md
+++ /dev/null
@@ -1,9 +0,0 @@
-### Bug reports
-
-See the [contributing guidelines](CONTRIBUTING.md) for sharing bug reports.
-
-### How-to
-
-For general troubleshooting or help getting started:
-
-- Join [GitHub Discussions](https://github.com/coreui/coreui-vue/discussions).
diff --git a/.github/workflows/daily-project-check.yml b/.github/workflows/daily-project-check.yml
deleted file mode 100644
index 5776ce77..00000000
--- a/.github/workflows/daily-project-check.yml
+++ /dev/null
@@ -1,31 +0,0 @@
-name: Daily project check
-
-on:
- schedule:
- # build runs every weekday at 6AM UTC
- - cron: '0 6 * * 1-5'
-
-jobs:
- build:
-
- runs-on: ubuntu-latest
-
- strategy:
- matrix:
- node-version: [12.x]
- os: [ubuntu-latest, windows-latest, macOS-latest]
-
- steps:
- - uses: actions/checkout@v1
- - name: Use Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v1
- with:
- node-version: ${{ matrix.node-version }}
- - name: npm install, build, test and lint
- run: |
- npm i
- npm run build
- npm run jest:test
- npm run lint
- env:
- CI: true
diff --git a/.github/workflows/project-check.yml b/.github/workflows/project-check.yml
deleted file mode 100644
index 854186a4..00000000
--- a/.github/workflows/project-check.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-name: Project check
-
-on:
- push:
- branches:
- - master
- pull_request:
- branches:
- - master
-
-jobs:
- build:
-
- runs-on: ubuntu-latest
-
- strategy:
- matrix:
- node-version: [12.x]
- os: [ubuntu-latest, windows-latest, macOS-latest]
-
- steps:
- - uses: actions/checkout@v1
- - name: Use Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v1
- with:
- node-version: ${{ matrix.node-version }}
- - name: npm install, build, test and lint
- run: |
- npm i
- npm run build
- npm run jest:test
- npm run lint
- env:
- CI: true
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
deleted file mode 100644
index 93e2ebb1..00000000
--- a/.github/workflows/stale.yml
+++ /dev/null
@@ -1,27 +0,0 @@
-# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
-#
-# You can adjust the behavior by modifying this file.
-# For more information, see:
-# https://github.com/actions/stale
-name: Mark stale issues and pull requests
-
-on:
- schedule:
- - cron: '17 14 * * *'
-
-jobs:
- stale:
-
- runs-on: ubuntu-latest
- permissions:
- issues: write
- pull-requests: write
-
- steps:
- - uses: actions/stale@v3
- with:
- repo-token: ${{ secrets.GITHUB_TOKEN }}
- stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions'
- stale-pr-message: 'This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions'
- stale-issue-label: 'no-issue-activity'
- stale-pr-label: 'no-pr-activity'
diff --git a/.gitignore b/.gitignore
index 054fb7a7..063b74e6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,42 +1,38 @@
-# Folders to ignore
+# Dependency directories
+node_modules/
+
+# Coverage directory
coverage/
+
+# Generated code
dist/
-node_modules/
-yarn.lock
-# local env files
-.env.local
-.env.*.local
+### Node ###
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
-# OS or Editor folders
-._*
-.cache
-.temp
-.DS_Store
+# Integrity files
+.yarn-integrity
+
+# Optional npm cache directory
+.npm
+
+# Editor directories and files
.idea
-.project
-.settings
-.tmproj
-*.esproj
-*.sublime-project
-*.sublime-workspace
+.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
-*.sw?
-nbproject
-Thumbs.db
-/.vscode/
-
-# Numerous always-ignore extensions
-*.diff
-*.err
-*.log
-*.orig
-*.rej
-*.swo
-*.swp
-*.vi
-*.zip
-*~
+
+# Misc
+.DS_Store
+
+# Optional eslint cache
+.eslintcache
+
+# dotenv environment variables file
+.env
diff --git a/.gitmodules b/.gitmodules
deleted file mode 100644
index 0aa07a72..00000000
--- a/.gitmodules
+++ /dev/null
@@ -1,8 +0,0 @@
-[submodule "packages/coreui-icons-vue"]
- path = packages/coreui-icons-vue
- url = https://github.com/coreui/coreui-icons-vue.git
- branch = main
-[submodule "packages/coreui-vue-chartjs"]
- path = packages/coreui-vue-chartjs
- url = https://github.com/coreui/coreui-vue-chartjs.git
- branch = main
diff --git a/.npmignore b/.npmignore
new file mode 100644
index 00000000..aa2c86f4
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,14 @@
+.babelrc
+.commitlintrc
+.editorconfig
+.esdoc.json
+.travis.yml
+yarn.lock
+.github/
+.storybook/
+coverage/
+node_modules/
+src/
+stories/
+jest.*.js
+rollup.config.js
\ No newline at end of file
diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 00000000..3ecb3981
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+8.9.0
\ No newline at end of file
diff --git a/.prettierignore b/.prettierignore
deleted file mode 100644
index 567609b1..00000000
--- a/.prettierignore
+++ /dev/null
@@ -1 +0,0 @@
-build/
diff --git a/.vscode/settings.json b/.vscode/settings.json
deleted file mode 100644
index 27a44689..00000000
--- a/.vscode/settings.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "editor.defaultFormatter": "esbenp.prettier-vscode"
- }
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..8bfbea92
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,80 @@
+### [@coreui/vue](https://coreui.io/) changelog
+
+##### v2.1.2
+- update `babel-plugin-module-resolver` to `^3.1.2`
+- update `eslint-config-prettier` to `^3.5.0`
+- update `eslint-plugin-jest` to `^22.1.3`
+- update `rollup-plugin-uglify` to `^6.0.1`
+- update `vue` to `^2.5.22`
+- update `vue-server-renderer` to `^2.5.22`
+- update `vue-template-compiler` to `^2.5.22`
+- lock `rollup-plugin-vue` on `4.3.2`
+
+##### v2.1.1
+- update `@vue/test-utils` to `^1.0.0-beta.28`
+- update `eslint` to `^5.12.0`
+- update `eslint-plugin-prettier` to `^3.0.1`
+- update `eslint-plugin-vue` to `^5.1.0`
+- update `husky` to `^1.3.1`
+- update `vue` to `^2.5.21`
+- update `vue-jest` to `^3.0.2`
+- update `vue-loader` to `^15.5.1`
+- update `vue-server-renderer` to `^2.5.21`
+- update `vue-template-compiler` to `^2.5.21`
+- update `jest-serializer-html` to `^6.0.0`
+- update `rollup` to `^0.68.2`
+
+##### v2.1.0
+- feat(SidebarNavLink): attributes
+- refactor(SidebarNav*): classes type [String, Array, Object]
+- test: update SidebarNavLabel, SidebarNavLink, SidebarNavDivider
+- refactor: rollup.config.js uglify()
+- chore: update jest.config.js
+- update `@vue/test-utils` to `^1.0.0-beta.27`
+- update `babel-plugin-dynamic-import-node` to `^2.2.0`
+- update `eslint` to `^5.10.0`
+- update `eslint-config-prettier` to `^3.3.0`
+- update `eslint-plugin-html` to `^5.0.0`
+- update `eslint-plugin-jest` to `^22.1.2`
+- update `eslint-plugin-vue` to `^5.0.0`
+- update `husky` to `^1.2.0`
+- update `lint-staged` to `^8.1.0`
+- update `node-sass` to `^4.11.0`
+- update `prettier` to `^1.15.3`
+- update `rollup` to `^0.67.4`
+- update `rollup-plugin-commonjs` to `^9.2.0`
+- update `rollup-plugin-filesize` to `^5.0.1`
+- update `rollup-plugin-replace` to `^2.1.0`
+- update `rollup-plugin-uglify` to `^6.0.0`
+- update `vue` to `^2.5.19`
+- update `vue-server-renderer` to `^2.5.19`
+- update `vue-template-compiler` to `^2.5.19`
+- update `vue-jest` to `^3.0.1`
+- update `vue-router` to `^3.0.2`
+- update `@coreui/coreui` to `^2.1.4`
+
+##### v2.0.2
+- fix(AsideToggler): add missing `display { default:'lg' }` prop value
+- fix(AsideToggler): add missing `defaultOpen` prop value handling
+- refactor(shared): add missing `index.js`
+
+##### v2.0.1
+- fix(SidebarNav): dirty fix for `rtl` ps scrolling issue
+- refactor(SidebarMinimizer): extract `togglePs` mixin
+- update `@vue/test-utils` to `^1.0.0-beta.25`
+- update `babel-eslint` to `^10.0.1`
+- update `babel-jest` to `^23.6.0`
+- update `eslint` to `^5.6.1`
+- update `eslint-config-prettier` to `^3.1.0`
+- update `eslint-plugin-html` to `^4.0.6`
+- update `eslint-plugin-jest` to `^21.24.1`
+- update `eslint-plugin-prettier` to `^3.0.0`
+- update `husky` to `^1.1.0`
+- update `jest` to `^23.6.0`
+- update `lint-staged` to `^7.3.0`
+- update `lodash` to `^4.17.11`
+- update `prettier` to `^1.14.3`
+- update `rollup-plugin-filesize` to `^4.0.1`
+- update `rollup-plugin-json` to `^3.1.0`
+- update `rollup-plugin-node-resolve` to `^3.4.0`
+- update `vue-loader` to `^15.4.2`
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index fbb053e0..00000000
--- a/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 creativeLabs Łukasz Holeczek
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 00000000..374976a1
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,7 @@
+Copyright 2018 Łukasz Holeczek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index 3d4aab99..444788f3 100644
--- a/README.md
+++ b/README.md
@@ -1,230 +1,54 @@
-
+[npm]: https://www.npmjs.com/package/@coreui/vue
+[npm-download]: https://img.shields.io/npm/dm/@coreui/vue.svg?style=flat-square
+> A [@coreui/vue](https://coreui.io/vue) `v2` library project
-## Table of contents
+for use with [CoreUI](https://coreui.io/vue/) `v2` Open Source Bootstrap Admin Template
-- [Quick start](#quick-start)
-- [Components](#components)
-- [Status](#status)
-- [Bugs and feature requests](#bugs-and-feature-requests)
-- [Documentation](#documentation)
-- [Frameworks](#frameworks)
-- [Templates](#templates)
-- [Contributing](#contributing)
-- [Community](#community)
-- [Versioning](#versioning)
-- [Creators](#creators)
-- [Support CoreUI Development](#support-coreui-development)
-- [Copyright and license](#copyright-and-license)
-
-## Quick start
-
-### Instalation
-
-Several quick start options are available:
-
-- [Download the latest release](https://github.com/coreui/coreui-vue/archive/v5.4.1.zip)
-- Clone the repo: `git clone https://github.com/coreui/coreui-vue.git`
-- Install with [npm](https://www.npmjs.com/): `npm install @coreui/vue`
-- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/vue`
-
-Read the [Getting started page](https://coreui.io/vue/docs/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
-
-### Stylesheets
-
-Vue components are styled using `@coreui/coreui` CSS library, but you can use them also with bootstrap CSS library. That is possible because `@coreui/coreui` library is compatible with bootstrap, it just extends its functionalities. The only exception are custom CoreUI components, which don't exist in the Bootstrap ecosystem.
-
-#### CoreUI CSS files
-
-##### Installation
-
-```bash
-yarn add @coreui/coreui
-```
-
-or
-
-```bash
-npm install @coreui/coreui --save
-```
-
-##### Basic usage
-
-```js
-import '@coreui/coreui/dist/css/coreui.min.css'
-```
-
-#### Bootstrap CSS files
-
-##### Installation
-
-```bash
-yarn add bootstrap
+## Installation
```
-
-or
-
-```bash
-npm install bootstrap
+npm install @coreui/vue
```
+@coreui/vue can be used as a module in both CommonJS and ES modular environments.
-##### Basic usage
+When in non-modular environment, @coreui/vue will register all the components to vue by itself.