npm

Need private packages and team management tools?Check out npm Orgs. »

@lrnwebcomponents/fluid-type

2.1.4 • Public • Published

<fluid-type>

Type

A simple fluid-type sizing wrapper element to apply to anything A web component implementation of this article https://andy-bell.design/wrote/custom-property-controlled-fluid-type-sizing/

Usage

To use this web component in your project you can utilize one of the following styles of syntax.

JS module

/* In an existing JS module / web component */
import '@lrnwebcomponents/fluid-type/fluid-type.js';
/* At top of an application with build routine */
<script type="module" src="@lrnwebcomponents/fluid-type/fluid-type.js"></script>
/* Alternatives for top of application */
<script type="module">
  import '@lrnwebcomponents/fluid-type/fluid-type.js';
  // if you don't have a build routine and need to reference directly
  import './node_modules/@lrnwebcomponents/fluid-type/fluid-type.js';
</script>
// via unpkg CDN (good for testing)
<script type="module" src="https://unpkg.com/@lrnwebcomponents/fluid-type/fluid-type.js"></script>

HTML / CSS

<style>
  fluid-type {
    --fluid-type-min-size: 2;
    --fluid-type-max-size: 5;
  }  
</style> 
<fluid-type><h1>This is fluid-type</h1></fluid-type>

Develop / Demo

Run yarn start will start a local development server, open your default browser to display it, open your finder to the correct window and start watching the /src directory for changes and automatically rebuilding the element and documentation site for the demo.

$ yarn start

Test

$ yarn run test

Build

Builds ensure that wcfactory can correctly compile your web component project to work on the maximum number of browsers possible.

$ yarn run build

Contributing

  1. Fork it! git clone https://github.com/elmsln/lrnwebcomponents.git
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Code style

Type (and all lrnwebcomponents) use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.

License

Apache-2.0 License

install

npm i @lrnwebcomponents/fluid-type

Downloadsweekly downloads

32

version

2.1.4

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability