Skip to content

A Svelte UI component for easy and intuitive file uploading

License

Notifications You must be signed in to change notification settings

svar-widgets/uploader

Repository files navigation

SVAR Svelte File Uploader

npm License npm downloads

A Svelte UI component for easy and intuitive file uploading, allowing users to drag and drop files or select them from their device.

How to Use

To use the widget, simply import the package and include the component in your Svelte file:

<script>
	import { Uploader, UploaderList } from "wx-svelte-uploader";

	let data = [];
	const uploadURL = "http://localhost:3000/data";

	function handleUpload(ev) {
		console.log(ev);
	}
</script>

<UploaderList bind:data />
<Uploader {uploadURL} bind:data onupload={handleUpload} />

Svelte 4 and Svelte 5 versions

There are two versions of the library: the 1.x version, designed to work with Svelte 4, and the 2.x version, created for Svelte 5. Please note that the 2.x version is in beta and may contain some instabilities.

To use the SVAR Uploader beta for Svelte 5, install it as follows:

npm install wx-svelte-uploader

To use the SVAR Uploader for Svelte 4:

npm install wx-svelte-uploader@1.3.0

How to Modify

Typically, you don't need to modify the code. However, if you wish to do so, follow these steps:

  1. Run yarn to install dependencies. Note that this project is a monorepo using yarn workspaces, so npm will not work
  2. Start the project in development mode with yarn start

Run Tests

To run the test:

  1. Start the test examples with:
    yarn start:tests
  2. In a separate console, run the end-to-end tests with:
    yarn test:cypress