A Svelte component to format and display a copyright notice.
This package is available on NPM, and you can install it with npm
or yarn
:
npm install -D svelte-copyright
yarn add -D svelte-copyright
Note that it only needs to be installed as a devDependency, like svelte
itself.
Import the Copyright
component and use it in your Svelte project.
<script>
import Copyright from 'svelte-copyright';
</script>
<footer>
<Copyright>
Dave Lunny
</Copyright>
</footer>
This will output HTML which looks something like this:
<footer>
<span>© Copyright 2023 Dave Lunny</span>
</footer>
All props are optional (as they all have default values).
Prop | Possible Values | Default Value | Description |
---|---|---|---|
date |
RFC2822/ISO8601 date string | new Date() |
Date for the copyright year. |
format |
'numeric' | '2-digit' |
'numeric' |
Format for the copyright year. |
position |
'pre' | 'post' |
'pre' |
Position of the Copyright relative to the contents you provide. |
showRange |
true | false |
false |
If true, displays a range from the date prop to the current year (ie: '2010 - 2020'). |
Additional Props
Note that any additonal props will be spread onto the component. This allows you to do things like provide a custom class
name to your component.
<Copyright class="custom-copyright">
Dave Lunny
</Copyright>
<style>
:global(.custom-copyright) {
color: lime;
}
</style>
Feel free to file an issue or open a pull request. Ensure that you add tests for any new functionality.
This was inspired by react-copyright
by Jason Bellamy.
✌️ Built by Dave Lunny.