@texttree/v-cana-rcl

v-cana-rcl

Explore the docs and code playground »

Report Bug · Request Feature

Table of Contents ↧

• About The Project
  • Built With
• Getting Started
  • Installation
  • Support
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

• Purpose React components library of interface elements for several V-cana projects.

• Problem When developing 2 V-cana projects - online and offline, it was found out that some components have similar functionality and design, therefore, for effective support and application development, it is necessary to make a common library into which such components will be transferred.

• Scope In the future, a method constructor will be added to this library. You can add components for a specific step either manually (by uploading Json with settings) or by selecting from the list. At the same time, it will be possible to change the number of blocks, tools and create your own tools for V-cana. And you will be able to see the result before adding this method to the application itself.

(back to top)

Built With

• React
• React Styleguidist

(back to top)

Getting Started

Installation

Add the library to your React app

• yarn

yarn add @texttree/v-cana-rcl

• npm

npm install @texttree/v-cana-rcl

(back to top)

Support

Having trouble? Get help in the official Open Components Ecosystem Discord

Usage

example_of_usage

For more examples, please refer to the Styleguidist link

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

First of all, we plan to add components to the library that are used on the translation page.

List of components (working names, taken from V-cana):

Workspace - component is common to all tools, accepts json, which specifies the parameters of a specific step and builds a set of tools based on it

A set of tools for the translation process:

PersonalNotes - allows you to work with the user's personal notes

Retelling - allows you to retell yourself using audio recording and listening.

BlindEditor - is a translation editor with the function of consecutive translation "verse by verse"

Editor - translation editor

Dictionary - allows you to work with the project dictionary

A set of tools for displaying materials:

Bible - shows the chapter/story as a list of verses (all verses of one chapter or only a certain range)

Info - shows the General Introduction of a particular book

TN - shows a list of Translation notes of a certain book(to all verses of one chapter or only a certain range)

TWL - shows a list of Translation words of a certain book(to all verses of one chapter or only a certain range)

TQ - shows a list of Translation quotes of a certain book(to all verses of one chapter or only a certain range)

Small additional components that are used in tools:

TNTWLContent - shows the content of a specific element (TN,TWL)

AutoSizeTextArea- used in all blocks where editing is in progress (BlindEditor,Editor)

In the future, this list will expand as the offline version is further developed and similar properties of components are identified.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.

You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature-[username]-amazing-feature)
3. Commit your Changes (git commit -m 'Add some Amazing Feature')
4. Push to the Branch (git push origin feature-[username]-amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/texttree/v-cana-rcl

(back to top)