https://github.com/ocean-ds/ocean-icons

Ocean DS SVG icons
https://github.com/ocean-ds/ocean-icons

icons icons-pack react svg

Last synced: 9 days ago
JSON representation

Ocean DS SVG icons

• Host: GitHub
• URL: https://github.com/ocean-ds/ocean-icons
• Owner: ocean-ds
• License: gpl-3.0
• Created: 2021-02-09T02:07:49.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T17:57:21.000Z (3 months ago)
• Last Synced: 2024-12-19T17:03:37.520Z (17 days ago)
• Topics: icons, icons-pack, react, svg
• Language: TypeScript
• Homepage: https://bit.ly/3JN3SlF
• Size: 1.29 MB
• Stars: 4
• Watchers: 11
• Forks: 4
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
Ocean Icons




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

    



This project is composed of many npm packages for building icons to the [Ocean](https://zeroheight.com/9c9b2b3aa/p/257272-ocean-ds/t/968532) design-system.

## Installation

```sh

yarn add @useblu/ocean-icons-react

```

or

```sh

npm i @useblu/ocean-icons-react

```

## Usage

```jsx

import React from 'react';

import ReactDOM from 'react-dom';

import { Sparkles } from '@useblu/ocean-icons-react';

function App() {

  return ;

}

ReactDOM.render(, document.querySelector('#root'));

```

Yes, it's really all you need to get started as you can see in this live and interactive demo:

[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/ocean-icons-ilimo)

## Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of this project! :blue_heart: Read below to learn how you can take part of it.

### Code of Conduct

We adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

### Contributing Guide

Read our [contributing guide](.github/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

### Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/ocean-ds/ocean-icons/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.

## Join our community

Join our [discord server](https://discord.gg/hDWzGPKuG2) to get the latest updates, chat with other Ocean enthusiasts, and see what's happening in the community!

## License

All packages are licensed under the terms of the [GPL-3.0 License](LICENSE).