teil-ui - npm Package Compare versions
Comparing version 0.0.0 to 0.0.1
| { | ||
| "name": "teil-ui", | ||
| "version": "0.0.0", | ||
| "version": "0.0.1", | ||
| "type": "module", | ||
@@ -9,4 +9,9 @@ "license": "MIT", | ||
| }, | ||
| "repository": { | ||
| "url": "https://github.com/sidharth-anand/teil-ui" | ||
| }, | ||
| "homepage": "https://sidharth-anand.github.io/teil-ui", | ||
| "devDependencies": { | ||
| "@el3um4s/svelte-get-component-info": "^0.0.16", | ||
| "@floating-ui/dom": "^1.1.0", | ||
| "@sveltejs/adapter-auto": "^1.0.1", | ||
@@ -17,2 +22,3 @@ "@sveltejs/adapter-static": "^1.0.5", | ||
| "@types/prismjs": "^1.26.0", | ||
| "aria-hidden": "^1.2.2", | ||
| "flexsearch": "^0.7.31", | ||
@@ -24,2 +30,4 @@ "mdsvex": "^0.10.6", | ||
| "svelte-check": "^2.10.3", | ||
| "svelte-floating-ui": "^1.2.8", | ||
| "svelte-portal": "^2.2.0", | ||
| "svelte-preprocess": "^5.0.0", | ||
@@ -33,8 +41,3 @@ "tslib": "^2.4.1", | ||
| }, | ||
| "dependencies": { | ||
| "@floating-ui/dom": "^1.0.9", | ||
| "aria-hidden": "^1.2.2", | ||
| "svelte-floating-ui": "^1.1.6", | ||
| "svelte-portal": "^2.2.0" | ||
| }, | ||
| "dependencies": {}, | ||
| "exports": { | ||
@@ -41,0 +44,0 @@ "./package.json": "./package.json", |
@@ -1,47 +0,24 @@ | ||
| # Svelte + TS + Vite | ||
| # TeilUI | ||
| This template should help get you started developing with Svelte and TypeScript in Vite. | ||
| TeilUI is the most comprehensive svelte headless low-level UI component library with an emphasis on accessibility, customisation, and developer experience. | ||
| You may utilise these components as the foundation of your design system or gradually integrate them into it. | ||
| Unlike most UI libraries, TeilUI is built specifically with [WAI-ARIA](https://www.w3.org/TR/wai-aria-practices/#aria_ex) compliance - both aria-attributes and keyboard navigation - in mind. | ||
| ## Recommended IDE Setup | ||
| # Documentation | ||
| [VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). | ||
| For full documentation visit [https://sidharth-anand.github.io/teil-ui](https://sidharth-anand.github.io/teil-ui) | ||
| ## Need an official Svelte framework? | ||
| # Installation | ||
| Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more. | ||
| ``` | ||
| npm install teil-ui | ||
| ``` | ||
| ## Technical considerations | ||
| # Authors | ||
| **Why use this over SvelteKit?** | ||
| - Sidharth Anand ([@sidharth-anand](https://github.com/sidharth-anand)) | ||
| - It brings its own routing solution which might not be preferable for some users. | ||
| - It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app. | ||
| # License | ||
| This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project. | ||
| Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate. | ||
| **Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?** | ||
| Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information. | ||
| **Why include `.vscode/extensions.json`?** | ||
| Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project. | ||
| **Why enable `allowJs` in the TS template?** | ||
| While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant. | ||
| **Why is HMR not preserving my local component state?** | ||
| HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr). | ||
| If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR. | ||
| ```ts | ||
| // store.ts | ||
| // An extremely simple external store | ||
| import { writable } from 'svelte/store'; | ||
| export default writable(0); | ||
| ``` | ||
| This project is licensed under the MIT License, Copyright © 2023-present [Sidharth Anand](https://github.com/sidharth-anand) | ||
| See the [LICENSE](LICENSE) file for details |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Improved metrics
- Dependency count
- decreased by-80%
1
- Number of low quality alerts
- decreased by-50%
1
Worsened metrics
- Total package byte prevSize
- decreased by-0.94%
216089
- Dev dependency count
- increased by25%
20
- Number of lines in readme file
- decreased by-50%
24
Dependency changes
- Removed@floating-ui/dom@^1.0.9
- Removedaria-hidden@^1.2.2
- Removedsvelte-floating-ui@^1.1.6
- Removedsvelte-portal@^2.2.0
- Removed@floating-ui/core@1.6.8(transitive)
- Removed@floating-ui/dom@1.6.12(transitive)
- Removed@floating-ui/utils@0.2.8(transitive)
- Removedaria-hidden@1.2.4(transitive)
- Removedsvelte-floating-ui@1.5.9(transitive)
- Removedsvelte-portal@2.2.1(transitive)
- Removedtslib@2.8.1(transitive)