diff --git a/README.md b/README.md index 342dc34..8a60841 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,16 @@ export default function App() { | onCategoryChangeFailed | function | warn(info) | no | Callback on category change failed (info: {index, highestMeasuredFrameIndex, averageItemLength}) | | translation | CategoryTranslation | en | no | Translation object *see translation section* | | disabledCategory | CategoryTypes[] | [] | no | Hide categories by passing their slugs | +## 🖼 Usage as static + +```js +import { EmojiKeyboard } from 'rn-emoji-keyboard'; + +// ... + + +``` +Example about serving as static keyboard [you can find here](/example/src/Dark/Dark.tsx). ## 🇺🇸 Internationalization ### Pre-defined Due to the limited translation possibilities, we only provide a few pre-defined translations into the following languages: @@ -101,11 +111,13 @@ You can clone the repo and run `yarn example ios` or `yarn example android` to p ![Preview](/example/assets/translated-preview.jpg) ### [DisabledCategories](/example/src/DisabledCategories/DisabledCategories.tsx) ![Preview](/example/assets/categories-preview.jpg) -### [Static (without knob)](/example/src/Static/Static.tsx) +### [StaticModal (without knob)](/example/src/StaticModal/StaticModal.tsx) +![Preview](/example/assets/static-modal-preview.jpg) +### [Static](/example/src/Static/Static.tsx) ![Preview](/example/assets/static-preview.jpg) ## 📈 Future plans * Skin tone palette selector. * Search bar. -* Hide forbidden emojis. +* Write native module to display forbidden emojis on android. ## ⚖️ License **[MIT](/LICENSE)** diff --git a/example/assets/static-modal-preview.jpg b/example/assets/static-modal-preview.jpg new file mode 100644 index 0000000..cdf165f Binary files /dev/null and b/example/assets/static-modal-preview.jpg differ diff --git a/example/assets/static-preview.jpg b/example/assets/static-preview.jpg index cdf165f..4189492 100644 Binary files a/example/assets/static-preview.jpg and b/example/assets/static-preview.jpg differ diff --git a/example/src/App.tsx b/example/src/App.tsx index 74b8418..67c9a24 100644 --- a/example/src/App.tsx +++ b/example/src/App.tsx @@ -7,6 +7,7 @@ import Basic from './Basic/Basic'; import Dark from './Dark/Dark'; import Translated from './Translated/Translated'; import DisabledCategories from './DisabledCategories/DisabledCategories'; +import StaticModal from './StaticModal/StaticModal'; import Static from './Static/Static'; const Stack = createStackNavigator(); @@ -22,6 +23,7 @@ export default () => { name="DisabledCategories" component={DisabledCategories} /> + diff --git a/example/src/Basic/Basic.tsx b/example/src/Basic/Basic.tsx index 198f860..3bfb3a6 100644 --- a/example/src/Basic/Basic.tsx +++ b/example/src/Basic/Basic.tsx @@ -14,7 +14,7 @@ const Basic = () => { setIsModalOpen((prev) => !prev); }; return ( - + Result: {result} setIsModalOpen(true)}> Open diff --git a/example/src/DisabledCategories/DisabledCategories.tsx b/example/src/DisabledCategories/DisabledCategories.tsx index 21a7294..3d6f72d 100644 --- a/example/src/DisabledCategories/DisabledCategories.tsx +++ b/example/src/DisabledCategories/DisabledCategories.tsx @@ -14,7 +14,7 @@ const DisabledCategories = () => { setIsModalOpen((prev) => !prev); }; return ( - + Result: {result} setIsModalOpen(true)}> Open diff --git a/example/src/Examples/Examples.tsx b/example/src/Examples/Examples.tsx index d8c992c..64a11b2 100644 --- a/example/src/Examples/Examples.tsx +++ b/example/src/Examples/Examples.tsx @@ -9,6 +9,7 @@ type RootStackParamList = { Dark: undefined; Translated: undefined; DisabledCategories: undefined; + StaticModal: undefined; Static: undefined; }; @@ -28,6 +29,10 @@ const Examples = ({ navigation }: Props) => { title="DisabledCategories" onPress={() => navigation.navigate('DisabledCategories')} /> +