Skip to content

A Svelte component library to create a single, sharable image composite of text on top of an image.

License

Notifications You must be signed in to change notification settings

sillsdev/svelte-text-image-composite

Repository files navigation

svelte-text-image-composite

Language GitHub license

Features

A Svelte component library to create a single, sharable image composite of text on top of an image.

Inspired by YouVersion's iOS implementation.

Users can edit:

  • Font
  • Font Size
  • Text Color
  • Line Height
  • Letter Spacing
  • Top / Left / Right Margins
  • Alignment
  • Color
  • Brightness
  • Opacity
  • Blur

Requirements

create-svelte

Everything you need to build a Svelte library, powered by create-svelte.

Read more about creating a library in the docs.

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of your library, everything inside src/routes can be used as a showcase or preview app.

Building

To build your library:

npm run package

To create a production version of your showcase app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Publishing

Go into the package.json and give your package the desired name through the "name" option. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

npm publish

About

A Svelte component library to create a single, sharable image composite of text on top of an image.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published