utopia-ui 1.0.7 → 1.0.8

package/LICENSE.md

@@ -0,0 +1,5 @@
+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.

package/README.md

@@ -1,17 +1,19 @@
-# Utopia UI
-Reuseable React Components to build mapping apps for all kinds of communities with focus of real life action, local connection and positiv impact.
+# Utopia UI [![npm version](https://img.shields.io/npm/v/utopia-ui.svg)](https://www.npmjs.com/package/utopia-ui)
+is a UI Library to build mapping apps with focus of real life action, local connection and positiv impact.
 
 Check [utopia-os.org](https://utopia-os.org) for more information
 
-*This Library is in early alpha stage. You are very welcome to participate in the development*
-
-*A Django-based Proof of Concept can be found @ [new.docutopia.de](https://new.docutopia.de). This map can be edited freely you can register to create an account and place them on the map. The project is no longer maintained.*
+*In early 2021, we developed a Django-based Proof of Concept, which can be found @ [new.docutopia.de](https://new.docutopia.de). This map can be edited freely you can register to create an account and place them on the map.*
 
-Utopia UI is a fully new approach to create a Open Source Library of JavaScript Components which should fit the needs of many different projects and communities. 
+Utopia UI is the approach to create a Open Source Library of JavaScript Components which should bring useful maps and apps to all kind of projects and communities.
 
 
 ## Map UI Component
-Map UI is a JavaScript Map Library to create nice and easy to use Maps 
+The Map Component based on [leaflet](https://leafletjs.com) is the crystalisation point of Utopia OS.
+
+The map shows places, events and people at their respective position whith nice and informative Popups. Tags, colors and clusters help to retain the overview.
+
+Include it somewhere in your React Application, pass some data and the required props.
 
 ### Getting Started
 
@@ -26,33 +28,20 @@ then import in your React App
 import UtopiaMap from 'utopia-ui'
 ```
 
-use the [Map UI Component](/docs/utopia-ui/map-components/map)
+use the Map UI Component
 ```jsx
-<UtopiaMap>
+<UtopiaMap
    height='360px'
    width='100vw'
    center={[51.3, 9.6]}
    zoom={6}
    places={places}
    events={events}
-   tags = {tags}
+   tags = {tags}>
 </UtopiaMap>
 ```
 You can find some Sample Data (places, events, tags) for test purpose below
 
-### Options
-
-
- Option         | Type              | Default      | Required   | Description 
- ---            | ---               | ---          | ---        | ---    
- `height`       | `string`          |`'400px'`     |    No      | height of the map           
- `width`        | `string`          |`'100vw'`     |    No      | width of the map
- `center`       | `LatLng`          |`[50.6, 9.5]` |    No      | initial map position           
- `zoom`         | `number`          |`10`          |    No      | initial zoom level
- `places`       | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)|         |  No         | Array with Items           
- `events`       | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)|         |  No         | Array with Items             
- `tags`       | [`Tag[]`](https://utopia-os.org/docs/utopia-ui/map-components/tag)    |         |  No         | Array with Tags  
-
 ### Sample Data
 ```jsx
 const places = [{
@@ -91,6 +80,19 @@ const tags = [
 
 ```
 
+### Options
+
+
+ Option         | Type              | Default      | Required   | Description 
+ ---            | ---               | ---          | ---        | ---    
+ `height`       | `string`          |`'400px'`     |    No      | height of the map           
+ `width`        | `string`          |`'100vw'`     |    No      | width of the map
+ `center`       | `LatLng`          |`[50.6, 9.5]` |    No      | initial map position           
+ `zoom`         | `number`          |`10`          |    No      | initial zoom level
+ `places`       | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)| `[]` | No | Array with Items           
+ `events`       | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)| `[]` | No | Array with Items             
+ `tags`         | [`Tag[]`](https://utopia-os.org/docs/utopia-ui/map-components/tag)  | `[]` | No | Array with Tags  
+
  ## Coming Soon
 
  * Profile UI Component
@@ -103,6 +105,8 @@ const tags = [
 
 ## Join the community
 
- *We are looking for Web Developer, UX Designer, Community Manager, Visionaries, Artists, etc. who like to support this Vision.*
+*This Library is in early alpha stage. You are very welcome to participate in the development*
+
+*We are looking for Web Developer, UX Designer, Community Manager, Visionaries, Artists, etc. who like to support this Vision.*
 
 [https://t.me/utopiaOS](https://t.me/utopiaOS)

package/dist/Components/Map/AddButton.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+export default function AddButton({ setSelectMode }: {
+    setSelectMode: React.Dispatch<React.SetStateAction<any>>;
+}): JSX.Element;

package/dist/Components/Map/Layer.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { Layer as LayerProps } from '../../types';
+export declare const Layer: (props: LayerProps) => JSX.Element;

package/dist/Components/Map/NewItemPopup.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+import { LatLng } from 'leaflet';
+import { Layer } from '../../types';
+export interface NewItemPopupProps {
+    position: LatLng;
+    layer: Layer;
+    setNewItemPopup: React.Dispatch<React.SetStateAction<any>>;
+}
+export default function NewItemPopup(props: NewItemPopupProps): JSX.Element;

package/dist/Components/Map/Popup.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { Item, Tag } from '../../types';
+export interface UtopiaPopupProps {
+    item: Item;
+    tags: Tag[];
+}
+declare const Popup: (props: UtopiaPopupProps) => JSX.Element;
+export { Popup };

package/dist/Components/Map/Subcomponents/AddButton.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+export default function AddButton({ setSelectMode }: {
+    setSelectMode: React.Dispatch<React.SetStateAction<any>>;
+}): JSX.Element;

package/dist/Components/Map/Subcomponents/EditItemPopup.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { LatLng } from 'leaflet';
+import { Layer, Item } from '../../../types';
+export interface EditItemPopupProps {
+    position: LatLng;
+    layer: Layer;
+    item?: Item;
+    setEditItemPopup: React.Dispatch<React.SetStateAction<any>>;
+}
+export default function EditItemPopup(props: EditItemPopupProps): JSX.Element;

package/dist/Components/Map/Subcomponents/NewItemPopup.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { LatLng } from 'leaflet';
+import { Layer, Item } from '../../../types';
+export interface NewItemPopupProps {
+    position: LatLng;
+    layer: Layer;
+    item?: Item;
+    setNewItemPopup: React.Dispatch<React.SetStateAction<any>>;
+}
+export default function NewItemPopup(props: NewItemPopupProps): JSX.Element;

package/dist/Components/Map/Subcomponents/Popup.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { Item, Tag } from '../../../types';
+import { NewItemPopupProps } from './NewItemPopup';
+export interface UtopiaPopupProps {
+    item: Item;
+    tags: Tag[];
+    setNewItemPopup?: React.Dispatch<React.SetStateAction<NewItemPopupProps | null>>;
+}
+declare const Popup: (props: UtopiaPopupProps) => JSX.Element;
+export { Popup };

package/dist/Components/Map/Tags.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { Tag } from '../../types';
+export declare function Tags({ data }: {
+    data: Tag[];
+}): JSX.Element;

package/dist/Components/Map/UtopiaMap.d.ts

@@ -0,0 +1,11 @@
+import "leaflet/dist/leaflet.css";
+import * as React from "react";
+import { Item, Tag, API, Layer, UtopiaMap as UtopiaMapProps } from "../../types";
+import "../../index.css";
+export interface MapEventListenerProps {
+    selectMode: Layer | null;
+    setSelectMode: React.Dispatch<React.SetStateAction<any>>;
+    setNewItemPopup: React.Dispatch<React.SetStateAction<any>>;
+}
+declare function UtopiaMap({ height, width, center, zoom, children }: UtopiaMapProps): JSX.Element;
+export { UtopiaMap, Item, Tag, API };

package/dist/Components/Map/UtopiaMap.stories.d.ts

@@ -0,0 +1,6 @@
+import { ComponentMeta } from "@storybook/react";
+import { UtopiaMap } from "./UtopiaMap";
+declare const _default: ComponentMeta<typeof UtopiaMap>;
+export default _default;
+export declare const Custom: any;
+export declare const BadSalzschlirf: any;

package/dist/Components/Map/data.d.ts

@@ -0,0 +1,4 @@
+import { Item, Tag } from "../../types";
+export declare const tags: Tag[];
+export declare const events: Item[];
+export declare const places: Item[];

package/dist/Components/Map/data.new.d.ts

@@ -0,0 +1,4 @@
+import { Item, Tag } from "../../types";
+export declare const tags: Tag[];
+export declare const events: Item[];
+export declare const places: Item[];

package/dist/Components/Map/hooks/useContext.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { NewItemPopupProps } from "../Subcomponents/NewItemPopup";
+declare function useNewItem(): {
+    newItemPopup: NewItemPopupProps | null;
+    setNewItemPopup: import("react").Dispatch<import("react").SetStateAction<NewItemPopupProps | null>>;
+};
+export default useNewItem;

package/dist/Components/Map/hooks/useForceUpdate.d.ts

@@ -0,0 +1 @@
+export declare function useForceUpdate(): () => void;

package/dist/Components/Map/hooks/useItems.d.ts

@@ -0,0 +1,18 @@
+import * as React from "react";
+import { Item } from "../../../types";
+declare type UseItemManagerResult = ReturnType<typeof useItemsManager>;
+declare function useItemsManager(initialItems: Item[]): {
+    items: Item[];
+    addItem: (item: Item) => void;
+    updateItem: (item: Item) => void;
+    removeItem: (item: Item) => void;
+};
+export declare const ItemsProvider: React.FunctionComponent<{
+    initialItems: Item[];
+    children?: React.ReactNode;
+}>;
+export declare const useItems: () => Item[];
+export declare const useAddItem: () => UseItemManagerResult["addItem"];
+export declare const useUpdateItem: () => UseItemManagerResult["updateItem"];
+export declare const useRemoveItem: () => UseItemManagerResult["removeItem"];
+export {};

package/dist/Components/Map/hooks/useLayers.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import { Layer } from "../../../types";
+declare type UseItemManagerResult = ReturnType<typeof useLayerManager>;
+declare function useLayerManager(initialLayers: Layer[]): {
+    layers: Layer[];
+    addLayer: (layer: Layer) => void;
+};
+export declare const LayersProvider: React.FunctionComponent<{
+    initialLayers: Layer[];
+    children?: React.ReactNode;
+}>;
+export declare const useLayers: () => Layer[];
+export declare const useAddLayer: () => UseItemManagerResult["addLayer"];
+export {};

package/dist/Components/Map/hooks/useMapContext.d.ts

@@ -0,0 +1,11 @@
+import * as React from "react";
+import { Layer } from "../../../types";
+import { NewItemPopupProps } from "../Subcomponents/NewItemPopup";
+export declare const MapContextProvider: React.FunctionComponent<{
+    initialValues: {
+        selectMode: null;
+        newItemPopup: null;
+    };
+    children?: React.ReactNode;
+}>;
+export declare const useMapContext: () => (Layer | React.Dispatch<React.SetStateAction<Layer | null>> | NewItemPopupProps | React.Dispatch<React.SetStateAction<NewItemPopupProps | null>> | null)[];

package/dist/Components/Map/hooks/useNewItemPopup.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { NewItemPopupProps } from "../Subcomponents/NewItemPopup";
+declare type ContextType = {
+    newItemPopup: NewItemPopupProps | null;
+    setNewItemPopup: (value: NewItemPopupProps | null) => void;
+};
+export declare const NewItemPopupProvider: (prop: {
+    value?: string;
+    children: JSX.Element | JSX.Element[];
+}) => JSX.Element;
+declare const useNewItemPopup: () => ContextType;
+export default useNewItemPopup;

package/dist/Components/Map/hooks/useTags.d.ts

@@ -0,0 +1,16 @@
+import * as React from "react";
+import { Tag } from "../../../types";
+declare type UseTagManagerResult = ReturnType<typeof useTagsManager>;
+declare function useTagsManager(initialTags: Tag[]): {
+    tags: Tag[];
+    addTag: (tag: Tag) => void;
+    removeTag: (id: number) => void;
+};
+export declare const TagsProvider: React.FunctionComponent<{
+    initialTags: Tag[];
+    children?: React.ReactNode;
+}>;
+export declare const useTags: () => Tag[];
+export declare const useAddTag: () => UseTagManagerResult["addTag"];
+export declare const useRemoveTag: () => UseTagManagerResult["removeTag"];
+export {};

package/dist/Components/Map/index.d.ts

@@ -0,0 +1,3 @@
+export { UtopiaMap, Item, Tag, API } from './UtopiaMap';
+export { Layer } from './Layer';
+export { Tags } from "./Tags";

package/dist/Components/Map/useItems.d.ts

@@ -0,0 +1,16 @@
+import * as React from "react";
+import { Item } from "../../types";
+declare type UseItemManagerResult = ReturnType<typeof useItemsManager>;
+declare function useItemsManager(initialItems: Item[]): {
+    items: Item[];
+    addItem: (item: Item) => void;
+    removeItem: (id: number) => void;
+};
+export declare const ItemsProvider: React.FunctionComponent<{
+    initialItems: Item[];
+    children?: React.ReactNode;
+}>;
+export declare const useItems: () => Item[];
+export declare const useAddItem: () => UseItemManagerResult["addItem"];
+export declare const useRemoveItem: () => UseItemManagerResult["removeItem"];
+export {};

package/dist/Components/Map/useLayers.d.ts

@@ -0,0 +1,18 @@
+import * as React from "react";
+import { Item, Layer } from "../../types";
+declare type UseItemManagerResult = ReturnType<typeof useLayerManager>;
+declare function useLayerManager(initialLayers: Map<string, Layer>): {
+    layers: Map<string, Layer>;
+    addLayer: (layer: Layer) => void;
+    addItem: (item: Item, layer: Layer) => void;
+    removeItem: (id: number, layer: Layer) => void;
+};
+export declare const LayersProvider: React.FunctionComponent<{
+    initialLayers: Map<string, Layer>;
+    children?: React.ReactNode;
+}>;
+export declare const useLayers: () => Map<string, Layer>;
+export declare const useAddLayer: () => UseItemManagerResult["addLayer"];
+export declare const useAddItem: () => UseItemManagerResult["addItem"];
+export declare const useRemoveItem: () => UseItemManagerResult["removeItem"];
+export {};

package/dist/Components/Map/useTags.d.ts

@@ -0,0 +1,16 @@
+import * as React from "react";
+import { Tag } from "../../types";
+declare type UseTagManagerResult = ReturnType<typeof useTagsManager>;
+declare function useTagsManager(initialTags: Tag[]): {
+    tags: Tag[];
+    addTag: (tag: Tag) => void;
+    removeTag: (id: number) => void;
+};
+export declare const TagsProvider: React.FunctionComponent<{
+    initialTags: Tag[];
+    children?: React.ReactNode;
+}>;
+export declare const useTags: () => Tag[];
+export declare const useAddTag: () => UseTagManagerResult["addTag"];
+export declare const useRemoveTag: () => UseTagManagerResult["removeTag"];
+export {};

package/dist/Utils/DynamicHeroIcon.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+declare const DynamicHeroIcon: FC<{
+    icon: string;
+}>;
+export default DynamicHeroIcon;

package/dist/Utils/ReplaceURLs.d.ts

@@ -0,0 +1 @@
+export declare function replaceURLs(message: string): string;

package/dist/index.d.ts

@@ -1,16 +1 @@
-/// <reference types="react" />
-import "leaflet/dist/leaflet.css";
-import { Item, Tag } from "./types";
-import "./styles.scss";
-import { LatLng } from "leaflet";
-export interface MapProps {
-    height: string;
-    width: string;
-    center: LatLng;
-    zoom: number;
-    places?: Item[];
-    events?: Item[];
-    tags?: Tag[];
-}
-declare const UtopiaMap: (props: MapProps) => JSX.Element;
-export { UtopiaMap, Item, Tag };
+export { UtopiaMap, Layer, Tags, Item, Tag, API } from './Components/Map/index';