🚀 readme updated

Author: Abdulnasır Olcan

README.md

@@ -1,16 +1,133 @@
 # Vue3 Use Hooks
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+<p align="center">Reusability and Composition functions.</p>
 
-## Recommended IDE Setup
+## :sunflower: Introduction
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+Vue Use Hooks implemented as vue composition functions.
 
-## Type Support For `.vue` Imports in TS
+## :package: Installation
 
-Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
+```bash
+# install with yarn
+yarn add vue3-use-hooks
+# install with npm
+npm install vue3-use-hooks
+```
 
-1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
-2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
+## :sparkles: useModal
 
-You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
+```vue
+<script setup lang="ts">
+import { useModal } from 'vue3-use-hooks';
+
+const contrubitors = [
+ {
+ id: 1,
+ emoji: '👨',
+ fullname: 'Abdulnasır Olcan',
+ programmer: 'Frontend Developer',
+ },
+ {
+ id: 2,
+ emoji: '👩',
+ fullname: 'Büşra Şanlıbayrak',
+ programmer: 'Frontend Developer',
+ },
+ {
+ id: 3,
+ emoji: '🧑‍',
+ fullname: 'Mehmet Varol',
+ programmer: 'Frontend Developer',
+ },
+];
+const { visible, setVisible, current, openModal, closeModal } = useModal();
+
+const handleButton = () => {
+ openModal(contrubitors);
+ setVisible(true);
+};
+</script>
+
+<template>
+ <div class="modal-vue">
+ <!-- button show -->
+ <button class="btn fourth" @click="handleButton">show model</button>
+
+ <!-- overlay -->
+ <div class="overlay" v-if="visible"></div>
+
+ <!-- modal -->
+ <div class="modal" v-if="visible">
+ <div class="modal-header">Modal Header</div>
+ <button class="close" @click="closeModal">x</button>
+ <div class="modal-content" v-for="contrubitor in current" :key="contrubitor.id">
+ <ul>
+ <li>
+ <p>{{ contrubitor.emoji }}</p>
+ <h1>{{ contrubitor.fullname }}</h1>
+ <span>{{ contrubitor.programmer }}</span>
+ </li>
+ </ul>
+ </div>
+ <div class="modal-footer">Modal Footer</div>
+ </div>
+ </div>
+</template>
+```
+
+## :sparkles: useState
+
+```vue
+<script setup lang="ts">
+import { useState } from 'vue3-use-hooks';
+const [count, setCount] = useState(0);
+
+</script>
+
+<template>
+ <div>
+ <p><b>Count: </b> {{ count }}</p>
+ <button class="fourth" @click="setCount(count - 1)">Decrement</button>
+ <button class="fourth" @click="setCount(count + 1)">Increment</button>
+ </div>
+</template>
+```
+
+## :sparkles: useStringCase
+
+```vue
+<script setup lang="ts">
+import { reactive } from 'vue';
+import { useStringCase } from 'vue3-use-hooks';
+
+const state = reactive({
+ name: 'imelda white',
+ gender: 'female',
+ company: 'NEUROCELL',
+ email: 'Imeldawhite@nr.com',
+ balance: '3,814.49',
+ about: 'Veniam fugiat pariatur adipisicing do consequat.',
+ address: 'bulwer place, lemoyne, district of columbia, 5597',
+});
+
+const { camelCase, kebabCase, pascalCase, upperCase, lowerCase, sentenceCase, capitalizeCase } = useStringCase();
+
+</script>
+
+<template>
+ <div>
+ <p><b>CamelCase: </b>{{ camelCase(state.about) }}</p>
+ <p><b>CapitalizeCase: </b>{{ capitalizeCase(state.name) }}</p>
+ <p><b>SentenceCase: </b>{{ sentenceCase(state.company) }}</p>
+ <p><b>KebabCase: </b>{{ kebabCase(state.balance) }}</p>
+ <p><b>PascalCase: </b>{{ pascalCase(state.address) }}</p>
+ <p><b>LowerCase: </b>{{ lowerCase(state.email) }}</p>
+ <p><b>UpperCase: </b>{{ upperCase(state.gender) }}</p>
+ </div>
+</template>
+```
+
+## License
+
+MIT