https://github.com/unfoldingword/world-language-map-rcl
Gets languages by clicking on a continent of the world map. Returns languages as objects to your function
https://github.com/unfoldingword/world-language-map-rcl
scripture-open-components
Last synced: 4 months ago
JSON representation
Gets languages by clicking on a continent of the world map. Returns languages as objects to your function
- Host: GitHub
- URL: https://github.com/unfoldingword/world-language-map-rcl
- Owner: unfoldingWord
- Created: 2024-10-07T20:11:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-13T01:07:52.000Z (over 1 year ago)
- Last Synced: 2025-03-23T16:16:03.042Z (about 1 year ago)
- Topics: scripture-open-components
- Language: JavaScript
- Homepage: https://world-language-map.netlify.app
- Size: 642 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# World Language Map RCL
This is a React component that renders a clickable world map. The continent clicked on will return the languages to the onContinentClick() function provided.
### Clone the Repository
To clone the repository, run the following command:
```bash
git clone https://github.com/unfoldingWord/world-language-map-rcl.git
```
### Installation
To install the dependencies and build the project, we recommend using [pnpm](https://pnpm.io/). If you don't have pnpm installed, you can install it by running:
```bash
npm install -g pnpm
```
Once pnpm is installed, navigate to the project directory and run the following command to install the dependencies:
```bash
pnpm install
```
### Development
To run the development server, use the following command:
```bash
pnpm dev
```
This will start the development server and you can view the component in your browser at `http://localhost:5173`.
### Usage as a 3rd Party App
To use WorldLanguageMap as a 3rd party app, follow these steps:
1. Install the package from npm:
```bash
npm install world-language-map-rcl
```
2. Import the component into your project:
```javascript
import { WorldLanguageMap } from 'world-language-map-rcl';
```
3. Use the component in your code:
```javascript
```
#### Props
The WorldLanguageMap component accepts the following props:
- `filterByCatalog`
- `subjects` (optional, defaults to all subjects): An array of strings representing the subjects to filter the catalog items.
- `metadataTypes` (optional, defaults to all metadata types)
- `stage` (optional, defaults to "prod"): A string that can be either "prod" (all releases), "latest" (master and all releases), or "other" (all branches, not just master) to specify the stage of the catalog items.
- `dcsApiUrl` (optional, defaults to https://git.door43.org/api/v1): A string representing the URL of the DCS API.
## License
This project is licensed under the MIT License.