Skip to content

Commit

Permalink
docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
infinite-system committed Aug 13, 2024
1 parent c9a92d8 commit d93e8d4
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 6 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,25 @@
&ndash; Only 1kb in size!<br />
&ndash; Production Ready<br />

## How Does it Work
## What is ivue?

## **ivue** is
<div style="padding-left:20px; font-size: 1.2rem; line-height: 2rem;">
&ndash;&nbsp; Simple like Options API<br />
&ndash;&nbsp; Flexible like Composition API<br />
&ndash;&nbsp; Extensible like TypeScript Classes API<br />
</div>

**ivue** is a powerful tool because it fully aligns itself with JavaScript / TypeScript Class API.

**ivue** gives you a class based Composable capabilities with Inheritance and all the power of TypeScript Classes.

**ivue** mitigates the downsides of both Composition API and Options API, uses only their strengths and brings back Object Oriented Programming to allow the development of complex and scalable apps.

**ivue** is fully interoperable with Composition API and does not work against, but rather with it, so you can use all of ecosystems composables seamlessly.

**ivue** also offers a set of functions and utility types to make extensible & exportable props defaults, extensible emits and extensible slots possible.


## Examples

Expand Down
11 changes: 10 additions & 1 deletion docs/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ export default defineConfig({
},
],
},

{ text: 'API' },
{
collapsed: false,
text: 'Core Functions',
Expand All @@ -112,6 +112,7 @@ export default defineConfig({
},

{
collapsed: false,
text: 'Utility Types',
items: [
{
Expand All @@ -123,6 +124,14 @@ export default defineConfig({
{ text: 'UnwrapComposable', link: '/pages/api#unwrapcomposable' },
],
},

{
collapsed: false,
text: 'Source Code',
items: [
{ text: 'Browse Code', link: '/pages/browse-code' },
],
},
],
},
base: '/ivue/',
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/pages/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ pnpm i ivue

## Install by Copying

`ivue` is designed to be easily shareable and installable so if you are running TypeScript, you can just copy the `index.ts` rename it to
`ivue.ts` in your repo and you are done:
`ivue` is designed to be easily shareable and installable so if you are running TypeScript, you can just copy the
`ivue.ts` into your repo and you are done:
:::details Click to expand the latest `ivue` source code to copy

:::code-group
Expand All @@ -28,5 +28,5 @@ pnpm i ivue
Or [Copy from GitHub](https://github.com/infinite-system/ivue/blob/main/src/index.ts)

::: tip NOTE
This installation path is recommended only if you quickly want to tinker with the internals of ivue, as you won't be getting the latest updates. Also note that this code comes from github `main` branch latest which might also be in beta and not fully pushed to `npm`.
This installation path is recommended only if you quickly want to tinker with the internals of ivue, as you won't be getting the latest updates. Also note that this code comes from github `main` branch latest which might also be in beta and not fully published to `npm`.
:::
2 changes: 1 addition & 1 deletion docs/docs/pages/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Utility Types help to achieve the rest of `ivue` capabilities
Or [See on GitHub](https://github.com/infinite-system/ivue/blob/main/src/index.ts)

## 100% Vue 3 Compatible
`.toRefs()` allows the object to be converted to native composable structure with full `.value`s, so it can interoperate with native composables if needed. `.toRefs()` is also often used to get refs for `v-bind()` in css styles.
`.toRefs()` allows the object to be converted to Vue 3 native composable structure with full `.value`s, so it can interoperate with native composables if needed. `.toRefs()` is also often used to get refs for `v-bind()` in css styles.

## 100% TypeScript Support

Expand Down

0 comments on commit d93e8d4

Please sign in to comment.