Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/naver/cfcs

Write once, create framework components that supports React, Vue, Svelte, and more.
https://github.com/naver/cfcs

cfcs egjs react svelte vue

Last synced: about 17 hours ago
JSON representation

Write once, create framework components that supports React, Vue, Svelte, and more.

Host: GitHub
URL: https://github.com/naver/cfcs
Owner: naver
License: mit
Created: 2022-08-29T10:25:23.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-04-17T21:27:41.000Z (over 1 year ago)
Last Synced: 2024-09-18T18:45:08.351Z (7 days ago)
Topics: cfcs, egjs, react, svelte, vue
Language: TypeScript
Homepage: https://naver.github.io/cfcs
Size: 3.31 MB
Stars: 102
Watchers: 7
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

Cross Framework Components

Write once, create framework components that supports React, Vue, Svelte, and more.

Demo / API / Tutorials

## Description

Many users use JavaScript frameworks and create or use components available in the framework.

However, if the component you want doesn't exist, you may have to find it externally or create it yourself.

Have you ever wanted to use Vanilla components in React or React components in Vue?

In order to support these JavaScript frameworks, the developers of JS libraries had to learn how to use each framework, and write and maintain code for each framework separately.

**CFCs**(Cross Framework Components) were developed to solve these problems.
With **CFCs**, **one code** can support multiple frameworks according to the framework's usage.

## Who should use this library?

In today's web front-end development, JavaScript frameworks have become very important.

The problem is that even though there are many great components, there are cases where JavaScript frameworks are not supported. Even newer JavaScript frameworks stand out even more.

Typically, you can call these libraries using the `mounted` lifecycle supported by frameworks, but often you won't be able to use some of their features or even use them at all.

For those who have had such experiences, we recommend using CFC.
In particular, we recommend **CFCs** if you:

1. **You want to develop a component to support various JavaScript frameworks.**
2. **You want to support existing components to various JavasScript frameworks.**

## Concepts
Previously, if you wanted to support different JavaScript frameworks, you had to write code for each one separately.

This meant that if you doubled the number of frameworks you wanted to support, the maintenance cost is also doubled.

With **CFCs**, you can use Compatible to support multiple frameworks with **just one code**.

![](https://raw.githubusercontent.com/naver/cfcs/main/images/cfcs-compatible.png)

### CFCs Reactive

**CFCs Reactive** can support multiple frameworks as a Reactive Component, a utility component that is state-based and does not create a UI.

![](https://raw.githubusercontent.com/naver/cfcs/main/images/cfcs-reactive.png)

**Reactive State** is a state that changes according to a specific condition.

You can detect state changes and also create a UI that changes based on conditions.

* [**See Reactive Documents**](https://github.com/naver/cfcs/blob/main/reactive.md)

#### CFCs Reactive-style components
* [ImReady](https://github.com/naver/egjs-imready): I'm Ready to check if the images or videos are loaded.
* [Axes](https://github.com/naver/egjs-axes): You can easily create a UI that responds to user actions.
* [Conveyer](https://github.com/naver/egjs-conveyer): Drag gestures to your Native Scroll.

## 📦 Packages
|Package|Version|Description|
|:-----:|:-----:|:-----:|
|[**@cfcs/core**](https://github.com/naver/cfcs/blob/main/packages/core/README.md)||CFCs for Core|
|[**@cfcs/react**](https://github.com/naver/cfcs/blob/main/packages/react/README.md)||CFCs for [React](https://reactjs.org/)|
|[**@cfcs/vue2**](https://github.com/naver/cfcs/blob/main/packages/vue2/README.md)||CFCs for [Vue.js@2](https://vuejs.org/v2/guide/index.html)|
|[**@cfcs/vue3**](https://github.com/naver/cfcs/blob/main/packages/vue3/README.md)||CFCs for [Vue.js@3](https://v3.vuejs.org/)|
|[**@cfcs/svelte**](https://github.com/naver/cfcs/blob/main/packages/svelte/README.md)||CFCs for [Svelte](https://svelte.dev/)|

## 📝 Feedback
Please file an [Issue](https://github.com/naver/cfcs/issues).

## 📜 License
`cfcs` is released under the [MIT license](https://github.com/naver/cfcs/blob/main/LICENSE).

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```