-
-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(web): added breakpointChrome and breakpointTailwindCSS (#132)
- Loading branch information
Showing
18 changed files
with
492 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Chrome breakpoints | ||
|
|
||
| > Use the Chrome breakpoints within javascript code. | ||
| ## Usage | ||
|
|
||
| Check [useBreakpoint](./breakpoint.md) for more detailed usage | ||
|
|
||
| ```js | ||
| import { useBreakpointChrome } from "vue-composable"; | ||
|
|
||
| useBreakpointChrome(); | ||
| /* Equivalent of: | ||
| useBreakpoint({ | ||
| mobileS: 320, | ||
| mobileM: 375, | ||
| mobileL: 425, | ||
| tablet: 768, | ||
| laptop: 1024, | ||
| laptopL: 1440, | ||
| desktop4K: 2560 | ||
| }) | ||
| */ | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # TailwindCSS breakpoints | ||
|
|
||
| > Use the TailwindCSS breakpoints within javascript code. | ||
| ## Parameters | ||
|
|
||
| ```js | ||
| import { useBreakpointTailwindCSS } from "vue-composable"; | ||
|
|
||
| useBreakpointTailwindCSS(tailwindConfig?); | ||
| ``` | ||
| | Parameters | Type | Required | Default | Description | | ||
| | -------------- | -------------------- | -------- | ----------- | --------------------------- | | ||
| | tailwindConfig | `tailwind.config.js` | `false` | `undefined` | `tailwind.config.js` object | | ||
| ## Usage | ||
| Check [useBreakpoint](./breakpoint.md) for more detailed usage | ||
| ### Default | ||
| ```js | ||
| import { useBreakpointTailwindCSS } from "vue-composable"; | ||
|
|
||
| /** | ||
| * it uses the default config found : | ||
| * https://github.com/tailwindcss/tailwindcss/blob/master/stubs/defaultConfig.stub.js | ||
| **/ | ||
| useBreakpointTailwindCSS(); | ||
| ``` | ||
| ### With custom `tailwind.config.js` | ||
| ```js | ||
| // tailwind.config.js | ||
| module.exports = { | ||
| theme: { | ||
| screens: { | ||
| mobileS: "320px", | ||
| mobileM: "375px", | ||
| mobileL: "425px", | ||
| tablet: "768px", | ||
| laptop: "1024px", | ||
| laptopL: "1440px" | ||
| } | ||
| }, | ||
| variants: { | ||
| /* custom variants */ | ||
| }, | ||
| plugins: [ | ||
| /* custom plugins */ | ||
| ] | ||
| }; | ||
|
|
||
| // usage | ||
| import { useBreakpointTailwindCSS } from "vue-composable"; | ||
| import tailwindConfig from "@/tailwind.config.js"; // location may be different | ||
|
|
||
| useBreakpointTailwindCSS(tailwindConfig); | ||
| /* Equivalent as: | ||
| useBreakpoint({ | ||
| mobileS: 320, | ||
| mobileM: 375, | ||
| mobileL: 425, | ||
| tablet: 768, | ||
| laptop: 1024, | ||
| laptopL: 1440 | ||
| }) | ||
| */ | ||
| ``` | ||
| ### Usage with `inject/provide` with `typescript` | ||
| ```ts | ||
| // parent.component.vue | ||
|
|
||
| import { | ||
| ExtractTailwindScreens, | ||
| useBreakpointTailwindCSS | ||
| } from "vue-composable"; | ||
| import tailwindConfig from "@/tailwind.config.js"; // location may be different | ||
|
|
||
| export type TailwindConfigType = typeof tailwindConfig; | ||
|
|
||
| setup(){ | ||
| setBreakpointTailwindCSS(tailwindConfig); // provide config | ||
| // ... | ||
| } | ||
|
|
||
| // child.component.vue | ||
|
|
||
| import { TailwindConfigType } from 'parent.component.vue' // you should move this type to an other file | ||
|
|
||
| setup(){ | ||
| useBreakpointTailwindCSS<TailwindConfigType>() // retrieve breakpoints | ||
| // ... | ||
| } | ||
|
|
||
| ``` |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.