slickgrid-vue 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +16 -11
  2. package/dist/index.mjs +117 -117
  3. package/dist/index.mjs.map +1 -1
  4. package/package.json +7 -7
  5. package/src/extensions/slickRowDetailView.ts +8 -9
  6. package/dist/index.d.cts +0 -775
package/README.md CHANGED
@@ -8,7 +8,10 @@
8
8
  [![Actions Status](https://github.com/ghiscoding/slickgrid-universal/actions/workflows/vue-cypress.yml/badge.svg)](https://github.com/ghiscoding/slickgrid-universal/actions/workflows/vue-cypress.yml)
9
9
 
10
10
  > [!WARNING]
11
- > Please note that Slickgrid-Vue is still in active development and usage might change depending on feedback provided by external users like you. However, I don't expect much changes though since all examples are working as expected. Give it a try and ⭐ the project if you like it!
11
+ > Please note that Slickgrid-Vue is still in active development and usage might change depending on feedback provided by external users like you. However, I don't expect much changes since all examples are working as expected. Give it a try and star ⭐ the project if you like it, thanks!
12
+
13
+ ## Description
14
+ SlickGrid-Vue is a custom component created specifically for [VueJS](https://vuejs.org/) framework, it is a wrapper on top of Slickgrid-Universal library which contains the core functionalities. Slickgrid-Universal is written with TypeScript in browser native code, it is framework agnostic and is a monorepo that includes all Editors, Filters, Extensions and Services related to SlickGrid usage with also a few optional packages (like GraphQL, OData, Export to Excel, ...).
12
15
 
13
16
  ## Documentation
14
17
  📘 [Documentation](https://ghiscoding.gitbook.io/slickgrid-vue/getting-started/quick-start) website is powered by GitBook.
@@ -25,15 +28,16 @@ npm install slickgrid-vue
25
28
  <script setup lang="ts">
26
29
  import { type Column, type GridOption, SlickgridVue } from 'slickgrid-vue';
27
30
 
28
- const columnDefinitions = ref<Column[]>([
29
- { id: 'username', name: 'Username', field: 'username'},
30
- { id: 'age', name: 'Age', field: 'age' }
31
+ const columnDefinitions: Ref<Column[]> = ref([
32
+ { id: 'firstName', name: 'First Name', field: 'firstName', sortable: true },
33
+ { id: 'lastName', name: 'Last Name', field: 'lastName', sortable: true },
34
+ { id: 'age', name: 'Age', field: 'age', type: 'number', sortable: true }
31
35
  ]);
32
36
  const dataset = ref([
33
- { id: 1, username: 'John', age: 20 },
34
- { id: 2, username: 'Jane', age: 21 }
37
+ { id: 1, firstName: 'John', lastName: 'Doe', age: 20 },
38
+ { id: 2, firstName: 'Jane', lastName: 'Smith', age: 21 }
35
39
  ]);
36
- const gridOptions = ref<GridOption>({ /*...*/ }); // optional
40
+ const gridOptions = ref<GridOption>({ /*...*/ }); // optional grid options
37
41
  </script>
38
42
 
39
43
  <slickgrid-vue
@@ -53,23 +57,24 @@ You can also play with the live Stackbliz [Slickgrid-Vite-Demos](https://github.
53
57
 
54
58
  [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/ghiscoding/slickgrid-vue-demos)
55
59
 
56
- Refer to the **[Docs - Quick Start](https://ghiscoding.gitbook.io/slickgrid-vue/getting-started/quick-start)** and/or clone the [Slickgrid-Vue-Demos](https://github.com/ghiscoding/slickgrid-vue-demos) repository for a local demo. Please make sure to read the documentation before opening any new issue and also consider asking installation and/or general questions on [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=slickgrid) unless you think there's a bug with the library.
60
+ Visit the **[Docs - Quick Start](https://ghiscoding.gitbook.io/slickgrid-vue/getting-started/quick-start)** and/or clone the [Slickgrid-Vue-Demos](https://github.com/ghiscoding/slickgrid-vue-demos) repository for a local demo. Please make sure to read the documentation before opening any new issue and also consider asking installation and/or general questions on [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=slickgrid) unless you think there's a bug with the library.
57
61
 
58
62
  ### Styling Themes
59
63
 
60
64
  Multiple styling themes are available
65
+ - Default (UI agnostic)
61
66
  - Bootstrap (see all Slickgrid-Vue [live demos](https://ghiscoding.github.io/slickgrid-vue-demos/))
62
67
  - Material (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example07))
63
68
  - Salesforce (see [Slickgrid-Universal](https://ghiscoding.github.io/slickgrid-universal/#/example16))
64
69
 
65
- Also note that all of these themes also have **Dark Theme** equivalent and even though Bootstrap is often used as the default, it does work as well with any other UI framework like Bulma, Material, Quasar...
70
+ Also note that all of these themes also have a **Dark Theme** equivalent and even though Bootstrap is often used for live demos, it does work well with any other UI framework like Bulma, Material, Quasar...
66
71
 
67
72
  ### Live Demo page
68
73
  `Slickgrid-Vue` works with all Bootstrap versions, you can see a demo of each one below. It also works well with any other frameworks like Material, Bulma, Quasar... and there are also extra styling themes based on Material & Salesforce which are also available. You can also use different SVG icons, you may want to look at the [Docs - SVG Icons](https://ghiscoding.gitbook.io/slickgrid-vue/styling/svg-icons)
69
74
  - [Bootstrap 5 demo](https://ghiscoding.github.io/slickgrid-vue-demos) / [examples repo](https://github.com/ghiscoding/slickgrid-vue-demos)
70
75
 
71
76
  #### Working Demos
72
- For a complete set of working demos (40+ examples), we strongly suggest you to clone the [Slickgrid-Vue Demos](https://github.com/ghiscoding/slickgrid-vue-demos) repository (instructions are provided in it). The repo provides multiple examples which are updated frequently (basically every time a new version is out) and is also used as the GitHub live demo page.
77
+ For a complete set of working demos (40+ examples), we strongly suggest you to clone the [Slickgrid-Vue Demos](https://github.com/ghiscoding/slickgrid-vue-demos) repository (instructions are provided in it). The repo comes with multiple examples and are updated frequently (basically every time a new version is out) and it is also used as the GitHub live demo page.
73
78
 
74
79
  ## License
75
80
  [MIT License](LICENSE)
@@ -81,6 +86,6 @@ Check out the [Releases](https://github.com/ghiscoding/slickgrid-universal/relea
81
86
  Slickgrid-Universal has **100%** Unit Test Coverage and all Slickgrid-Vue Examples are tested with [Cypress](https://www.cypress.io/) for E2E testing and they run anytime a new PR is created.
82
87
 
83
88
  ### Like it? ⭐ it
84
- You like **Slickgrid-Vue**? Be sure to upvote ⭐, and perhaps support me with caffeine [☕](https://ko-fi.com/ghiscoding) and feel free to contribute. 👷👷‍♀️
89
+ You like **Slickgrid-Vue**? Be sure to upvote ⭐, and perhaps support me with caffeine [☕](https://ko-fi.com/ghiscoding) or sponsor me on GitHub and feel free to contribute at any time. Thanks
85
90
 
86
91
  <a href='https://ko-fi.com/ghiscoding' target='_blank'><img height='32' style='border:0px;height:32px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />