Novice, Paragon, Master

    svelte-flagpack

    1.0.0 • Public • Published

    Flagpack

    Flagpack contains 250+ flag icons to easily use within your code project. Flagpack is an open source project and available for JavaScript frameworks/libraries Angular, Vue, Svelte and React.

    Flagpack. 250+ easily implementable flag icons to use in your design or code project. Open Source. Available for Sketch, Figma, Angular, Vue, Svelte and React. www.flagpack.xyz. Made with love by Yummygum. Graphic showing a list with the flags of Argentina, Croatia, Estonia, Kenia, Netherlands, and Scotland.

    View documentation on flagpack.xyz

    svelte-flagpack

    Installation

    $: npm install svelte-flagpack --save

    Usage

    Defining the component

    Import the Flagpack component into any of your project's Svelte components.

    import Flag from 'svelte-flagpack'

    Use in Svelte

    <Flag
      code="NL"
      gradient="real-linear"
      size="m"
      hasDropShadow
    />

    Available component configurations — Props

    Key Value Required Default Format
    code String false 'NL' See all codes
    size String false 'L' 'S', 'M' or 'L'
    className String false - -
    hasDropShadow Boolean false false -
    hasBorder Boolean false true -
    hasBorderRadius Boolean false true -
    gradient String false '' 'top-down', 'real-linear' or 'real-circular'

    Build

    # install dependencies
    $: npm install
    
    # build for prod
    $: npm run build
    
    # build with watcher for dev
    $: npm run dev

    Releasing

    To release a new version you'll need to make sure all changes commits are done and pushed. After that you'll need to decide which release type you want to use. The release types are; patch (0.0.1), minor (0.1.0), or major (1.0.0).

    $: npm version <release_type>
    

    This will update the version number in the package.json, and will add a git tag automatically. Next you'll need to push the git tag to the remote.

    $: git push --tags origin main
    

    After that you'll need to publish to npm.

    $: npm publish
    

    When you're confident with the release, make sure the version tag is also released at GitHub.

    Support

    Frequently Asked Questions

    Documentation

    Releases

    You can find a changelog of Flagpack's releases on the Releases page on GitHub.

    Contribute

    If you're interested in contributing to this project, great! Please see the contributing document how to set up you up.

    License

    Flagpack is an open source project published under a MIT license.

    Install

    npm i svelte-flagpack

    DownloadsWeekly Downloads

    114

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    7.51 MB

    Total Files

    2257

    Last publish

    Collaborators

    • yummygum