3.12.1 • Published 8 months ago

@conectate/ct-icon v3.12.1

Weekly downloads
3
License
BSD-3-Clause
Repository
github
Last release
8 months ago

This is an implementation to be able to use the Material Icons with web components

See: https://fonts.google.com/icons

Installation

To include this, type in terminal:

yarn add @conectate/ct-icon
# or
npm i @conectate/ct-icon

Example

<!-- See: https://fonts.google.com/icons for more icons -->
<ct-icon icon="settings"></ct-icon>
<!-- Or -->
<ct-icon-button icon="headphones"></ct-icon-button>

ES Modules

If you will use lit, react, vue, etc. need to import the web component.

LitElement example (Typescript)

import "@conectate/ct-icon";
import "@conectate/ct-icon-button";

// my-element.ts
import { LitElement, customElement, html } from "lit";

@customElement("my-element")
class MyElement extends LitElement {
	render() {
		return html`
			<ct-icon icon="print"></ct-icon>
			<ct-icon-button icon="headphones"></ct-icon-button>
		`;
	}
}

Change font style

import "@conectate/ct-icon";

import { CtIcon } from "@conectate/ct-icon";
// my-element.ts
import { LitElement, customElement, html } from "lit";

@customElement("my-element")
class MyElement extends LitElement {
	constructor() {
		// Select type
		CtIcon.FontStyle = "Sharp";
	}

	render() {
		return html`<style>
				/* Specify new font family */
				ct-icon {
					font-family: "Material Icons Sharp";
				}
			</style>

			<ct-icon icon="print"></ct-icon>`;
	}
}

VS Code intellisense support

The component has support to autocomplete the more than 1000 existing icons by Google Fonts Visual Sttudio Code intellisense support

Properties

PropertyAttributeTypeDefaultDescription
FontStylestatic type"Outlined"\|"Fill"\|"Sharp"\|"Two Tone"\|"Round""Round"Select Font Style with static propety - CtIcon.FontStyle = "Round"
iconiconiconIcon name described in Google Fonts
svgsvgstring""If the desired icon does not exist icon in Google Fonts, you can use an SVG by sending it as a string

Follow me

Herberth_thumb

https://twitter.com/herberthobregon

Contributing

  1. Fork it!
  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

License

See LICENSE

3.9.0

9 months ago

3.11.0

8 months ago

3.8.0

10 months ago

3.10.0

8 months ago

3.12.1

8 months ago

3.12.0

8 months ago

3.11.1

8 months ago

3.7.2

2 years ago

3.7.0

2 years ago

3.6.0

2 years ago

3.5.0

3 years ago

3.4.0

3 years ago

3.3.1

3 years ago

3.2.1

3 years ago

3.2.0

3 years ago

3.1.1

3 years ago

3.1.0

3 years ago

3.0.1

3 years ago

3.0.0

3 years ago

1.6.1

3 years ago

1.6.0

3 years ago

1.5.1

3 years ago

1.5.0

3 years ago

1.4.0

3 years ago

1.0.2

3 years ago