mirror of
https://gitlab.nic.cz/turris/reforis/foris-js.git
synced 2024-11-14 17:35:35 +01:00
Compare commits
No commits in common. "a4fd74bf3823e68019baebba307b241f3ed05d6c" and "d588291f1c4f16bcb6b21b6a51f44ae28950362b" have entirely different histories.
a4fd74bf38
...
d588291f1c
|
@ -1,36 +0,0 @@
|
||||||
import React from "react";
|
|
||||||
import PropTypes from "prop-types";
|
|
||||||
import Styled from "rsg-components/Styled";
|
|
||||||
import logo from "./logo.svg";
|
|
||||||
|
|
||||||
const styles = ({ fontFamily }) => ({
|
|
||||||
logo: {
|
|
||||||
display: "flex",
|
|
||||||
alignItems: "center",
|
|
||||||
margin: 0,
|
|
||||||
fontFamily: fontFamily.base,
|
|
||||||
fontSize: 18,
|
|
||||||
fontWeight: "normal",
|
|
||||||
},
|
|
||||||
image: {
|
|
||||||
height: "1.3em",
|
|
||||||
marginLeft: "-0.2em",
|
|
||||||
marginRight: "0.2em",
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
export function LogoRenderer({ classes, children }) {
|
|
||||||
return (
|
|
||||||
<h1 className={classes.logo}>
|
|
||||||
<img className={classes.image} src={logo} alt="React logo" />
|
|
||||||
{children}
|
|
||||||
</h1>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
LogoRenderer.propTypes = {
|
|
||||||
classes: PropTypes.object.isRequired,
|
|
||||||
children: PropTypes.node,
|
|
||||||
};
|
|
||||||
|
|
||||||
export default Styled(styles)(LogoRenderer);
|
|
|
@ -1,3 +0,0 @@
|
||||||
<svg xmlns="http://www.w3.org/2000/svg" width="1000" height="1000">
|
|
||||||
<path d="M288.258 240.0394L717.5586-.44c.803 62.277-1.8207 124.502-1.4996 186.7266 1.8208 7.6343-7.2288 10.1966-12.102 13.4908L286.4375 432.1518l1.8206-192.1124zm2.284 277.645L711 278.3176l-.8416 192.7742L457.357 614.514l-1.842 289.03-167.7097 95.8926 2.7365-481.753z"/>
|
|
||||||
</svg>
|
|
Before Width: | Height: | Size: 349 B |
|
@ -1,15 +1,15 @@
|
||||||
Sooner or later, you will face with situation when you want/need to make some
|
Sooner or later you will face with situation when you want/need to make some
|
||||||
changes in the library. Then the most important tool for you it's the
|
changes in the library. Then the most important tool for you it's
|
||||||
[`npm link`](https://docs.npmjs.com/cli/link).
|
[`npm link`](https://docs.npmjs.com/cli/link).
|
||||||
|
|
||||||
Please, notice that it will not work if you link the library just from the root
|
Please, notice that it will not work if you link library just from root of the
|
||||||
of the repo. It happens due to the location of sources `./src`. You need to pack
|
repo. It happens due to location of sources `./src`. You need to pack library
|
||||||
the library first, `make pack` and then link it from the `./dist` directory.
|
first `make pack` and then link it from `./dist` directory.
|
||||||
|
|
||||||
Yeah, it's not such a comfortable solution for development. But it can be fixed
|
Yeah it's not such comfortable solution for development. But it can fixed by
|
||||||
by writing a small script similar to making a pack but by linking every file and
|
writing small script similar as `make pack` but with linking every file and
|
||||||
directory from `./src` to the same directory and linking then from it. Notice
|
directory from `./src` to the some directory and linking then from it. Notice
|
||||||
that you need to link a `package.json` and a `package-lock.json` as well.
|
that you need to link `package.json` and `package-lock.json` as well.
|
||||||
|
|
||||||
So step by step:
|
So step by step:
|
||||||
|
|
||||||
|
|
|
@ -1,4 +0,0 @@
|
||||||
<svg xmlns="http://www.w3.org/2000/svg" width="500" height="500" fill="white">
|
|
||||||
<path d="M49.5 171.722222222222h400v133.333333333333h-200v22.222222222223h-88.888888888889v-22.222222222223H49.5V171.722222222222zm22.222222222222 111.111111111111h44.444444444445v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-88.888888888889H71.722222222222v88.888888888889zm111.111111111111-88.888888888889v111.111111111111h44.444444444445v-22.222222222222h44.444444444444v-88.888888888889h-88.888888888889zm44.444444444445 22.222222222222H249.5v44.444444444445h-22.222222222222v-44.444444444445zm66.666666666666-22.222222222222v88.888888888889h44.444444444445v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-66.666666666667h22.222222222222v66.666666666667h22.222222222223v-88.888888888889H293.944444444444z" fill="#cb3837" />
|
|
||||||
<path d="M71.722222222222 282.833333333333h44.444444444444v-66.666666666667h22.222222222223v66.666666666667h22.222222222222v-88.888888888889H71.722222222222zm111.111111111111-88.888888888889v111.111111111111h44.444444444444v-22.222222222222h44.444444444445v-88.888888888889h-88.888888888889zM249.5 260.611111111111h-22.222222222223v-44.444444444445H249.5v44.444444444445zm44.444444444444-66.666666666667v88.888888888889h44.444444444444v-66.666666666667h22.222222222223v66.666666666667h22.222222222222v-66.666666666667h22.222222222222v66.666666666667h22.222222222222v-88.888888888889z" />
|
|
||||||
</svg>
|
|
Before Width: | Height: | Size: 1.4 KiB |
6
docs/intro.md
Normal file
6
docs/intro.md
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
Foris JS library is set of components and utils for Foris JS application and
|
||||||
|
plugins.
|
||||||
|
|
||||||
|
Please notice that all of these components or utils are used in reForis and
|
||||||
|
plugins. If you like to study by example I would recommend to full-text search
|
||||||
|
these repos.
|
|
@ -1,37 +0,0 @@
|
||||||
Welcome! This is the official documentation for Foris JS.
|
|
||||||
|
|
||||||
## What Foris JS is
|
|
||||||
|
|
||||||
Foris JS library is a set of components and utils for reForis application and
|
|
||||||
plugins.
|
|
||||||
|
|
||||||
Please notice that all of these components or utils are used in reForis and
|
|
||||||
plugins. If you want to study them by example, I recommend you to full-text
|
|
||||||
search those repositories.
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
Please make sure that [Node.js](https://nodejs.org/en/) is installed on your
|
|
||||||
system.
|
|
||||||
|
|
||||||
The current Long Term Support (LTS) release is an ideal starting point, see
|
|
||||||
[here](https://github.com/nodejs/Release#release-schedule).
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
To install the latest release:
|
|
||||||
|
|
||||||
```plain
|
|
||||||
npm install foris
|
|
||||||
```
|
|
||||||
|
|
||||||
To install a specific version:
|
|
||||||
|
|
||||||
```plain
|
|
||||||
npm install foris@version
|
|
||||||
```
|
|
||||||
|
|
||||||
<a target="_blank" href="https://www.npmjs.com/package/foris">Check
|
|
||||||
on<img width="100px" src="./docs/forisjs-npm.svg"></a>
|
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "foris",
|
"name": "foris",
|
||||||
"version": "5.4.1",
|
"version": "5.4.1",
|
||||||
"description": "Foris JS library is a set of components and utils for reForis application and plugins.",
|
"description": "Set of components and utils for Foris and its plugins.",
|
||||||
"author": "CZ.NIC, z.s.p.o.",
|
"author": "CZ.NIC, z.s.p.o.",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
Switch example:
|
|
||||||
|
|
||||||
```js
|
|
||||||
<Switch label="Enable Switch" helpText="Toggle that switch!" />
|
|
||||||
```
|
|
|
@ -1,56 +1,39 @@
|
||||||
/*
|
/*
|
||||||
* Copyright (C) 2019-2022 CZ.NIC z.s.p.o. (https://www.nic.cz/)
|
* Copyright (C) 2019 CZ.NIC z.s.p.o. (http://www.nic.cz/)
|
||||||
*
|
*
|
||||||
* This is free software, licensed under the GNU General Public License v3.
|
* This is free software, licensed under the GNU General Public License v3.
|
||||||
* See /LICENSE for more information.
|
* See /LICENSE for more information.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
const path = require("path");
|
const path = require("path");
|
||||||
const pjson = require("./package.json");
|
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
title: "Foris JS Docs",
|
title: "Foris JS docs",
|
||||||
version: `v${pjson.version}`,
|
|
||||||
theme: {
|
|
||||||
color: {
|
|
||||||
link: "#0075a3",
|
|
||||||
linkHover: "#00a2e2",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
tocMode: "collapse",
|
|
||||||
pagePerSection: true,
|
|
||||||
sections: [
|
sections: [
|
||||||
{
|
{
|
||||||
name: "Introduction",
|
name: "Foris JS",
|
||||||
content: "docs/introduction.md",
|
content: "docs/intro.md",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Development",
|
name: "Development (Linking)",
|
||||||
content: "docs/development.md",
|
content: "docs/development.md",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "Components",
|
name: "Foris forms",
|
||||||
description: "Set of main components.",
|
components: [
|
||||||
sections: [
|
"src/form/components/ForisForm.js",
|
||||||
{
|
"src/form/components/alerts.js",
|
||||||
name: "Foris forms",
|
"src/form/components/SubmitButton.js",
|
||||||
components: [
|
|
||||||
"src/form/components/ForisForm.js",
|
|
||||||
"src/form/components/alerts.js",
|
|
||||||
"src/form/components/SubmitButton.js",
|
|
||||||
],
|
|
||||||
exampleMode: "expand",
|
|
||||||
usageMode: "expand",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "Alert Context",
|
|
||||||
components: ["src/alertContext/AlertContext.js"],
|
|
||||||
exampleMode: "expand",
|
|
||||||
usageMode: "expand",
|
|
||||||
},
|
|
||||||
],
|
],
|
||||||
sectionDepth: 1,
|
exampleMode: "expand",
|
||||||
|
usageMode: "expand",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Alert Context",
|
||||||
|
components: ["src/alertContext/AlertContext.js"],
|
||||||
|
exampleMode: "expand",
|
||||||
|
usageMode: "expand",
|
||||||
},
|
},
|
||||||
|
|
||||||
{
|
{
|
||||||
name: "Bootstrap components",
|
name: "Bootstrap components",
|
||||||
description: "Set of bootstrap components.",
|
description: "Set of bootstrap components.",
|
||||||
|
@ -58,12 +41,8 @@ module.exports = {
|
||||||
exampleMode: "expand",
|
exampleMode: "expand",
|
||||||
usageMode: "expand",
|
usageMode: "expand",
|
||||||
ignore: ["src/bootstrap/constants.js"],
|
ignore: ["src/bootstrap/constants.js"],
|
||||||
sectionDepth: 0,
|
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
template: {
|
|
||||||
favicon: "/docs/components/logo.svg",
|
|
||||||
},
|
|
||||||
require: [
|
require: [
|
||||||
"babel-polyfill",
|
"babel-polyfill",
|
||||||
path.join(__dirname, "src/testUtils/mockGlobals"),
|
path.join(__dirname, "src/testUtils/mockGlobals"),
|
||||||
|
@ -76,9 +55,6 @@ module.exports = {
|
||||||
"node_modules/@fortawesome/fontawesome-free/css/all.min.css"
|
"node_modules/@fortawesome/fontawesome-free/css/all.min.css"
|
||||||
),
|
),
|
||||||
],
|
],
|
||||||
styleguideComponents: {
|
|
||||||
LogoRenderer: path.join(__dirname, "docs/components/Logo"),
|
|
||||||
},
|
|
||||||
webpackConfig: {
|
webpackConfig: {
|
||||||
module: {
|
module: {
|
||||||
rules: [
|
rules: [
|
||||||
|
@ -97,8 +73,5 @@ module.exports = {
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
devServer: {
|
|
||||||
publicPath: "/",
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in New Issue
Block a user