Skip to content

chore: update main branch #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 14, 2024
Merged

chore: update main branch #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
eb65718
chore: add linter to markdown documents
Proskynete Jan 24, 2023
4547e0f
chore(release): 4.4.2
Proskynete Jan 24, 2023
34cd3c9
fix: modify hooks scripts
Proskynete Jan 25, 2023
3252e75
chore(release): 4.4.3
Proskynete Jan 25, 2023
89b2fa4
chore: update funding file
Proskynete Apr 14, 2024
5531f2c
chore: update readme file
Proskynete Apr 14, 2024
76cb04f
chore: update tests
Proskynete Apr 14, 2024
b5d5926
ci: update tests
Proskynete Apr 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/funding.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
github: Proskynete
custom: https://thanks.eduardoalvarez.dev/donate
custom: https://eduardoalvarez.dev/donaciones
buy_me_a_coffee: eduardoalvarez.dev
6 changes: 5 additions & 1 deletion .lintstagedrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"*.{ts,tsx,js,jsx}": [
"npm run lint:fix",
"git add"
"git add ."
],
"*.md": [
"markdownlint --fix",
"git add ."
]
}
41 changes: 41 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## 4.4.3 (2023-01-25)


### Features

* new version ([21193f6](https://github.com/Proskynete/vertical-timeline-component-react/commit/21193f683252fc9b97b91af6334c44b45125c665))
* Use toLocaleDateString API for transform date using custom lang ([8590988](https://github.com/Proskynete/vertical-timeline-component-react/commit/85909880343144c856cc2f8f55f8bbe8ed3ffaf2))


### Bug Fixes

* Add styles and documentation for turkish translation ([7703bca](https://github.com/Proskynete/vertical-timeline-component-react/commit/7703bcaf608bb8df31f544ba1affc96600488688))
* change custom funding url ([4b8a37d](https://github.com/Proskynete/vertical-timeline-component-react/commit/4b8a37dfae740f714c6d69e398ce68506d6a8f55))
* change licence document to MIT and return interfaces from main route ([a336cc4](https://github.com/Proskynete/vertical-timeline-component-react/commit/a336cc4e94ff220137b157038939dd4b70a2b872))
* Change project - now use typescript ([8341264](https://github.com/Proskynete/vertical-timeline-component-react/commit/8341264e3445b380e584f106fd55c89fa746593b))
* Change replaceAll for replace ([392ff25](https://github.com/Proskynete/vertical-timeline-component-react/commit/392ff25a15029d5aeffe2f17e21ee12bcb6caebf))
* error in ci github action ([df457a7](https://github.com/Proskynete/vertical-timeline-component-react/commit/df457a7dd41c9dd67b13ab1f3ba7913020f05323))
* error on react and react-dom dependencies ([7c796e9](https://github.com/Proskynete/vertical-timeline-component-react/commit/7c796e96a37aafc962c4354702ba57b4129cc2d2))
* github action ([cd65a5d](https://github.com/Proskynete/vertical-timeline-component-react/commit/cd65a5d5b016960bfde09308e0c44c3fd40ce723))
* github action ([60ee3ec](https://github.com/Proskynete/vertical-timeline-component-react/commit/60ee3ec791237d37383507650cb77b275fed496e))
* github action ([e0a65b4](https://github.com/Proskynete/vertical-timeline-component-react/commit/e0a65b4d7b9104fd402c2110248733d76540fee1))
* husky, lint-staged and lint-commit config ([b881104](https://github.com/Proskynete/vertical-timeline-component-react/commit/b881104ec1f8a6b9c19bc197dc29583b3d6a7d21))
* modify hooks scripts ([34cd3c9](https://github.com/Proskynete/vertical-timeline-component-react/commit/34cd3c9923cd6e6408157837a96387607c21daad))
* readme documentation ([6fbc62f](https://github.com/Proskynete/vertical-timeline-component-react/commit/6fbc62f9704c8d90f3280fa8a082dc349e9d84ba))
* readme documentation ([18a6103](https://github.com/Proskynete/vertical-timeline-component-react/commit/18a6103f03fea89a6963f27d4ca2dfe4885c43cd))
* **snapshot:** update snapshot ([c2743b6](https://github.com/Proskynete/vertical-timeline-component-react/commit/c2743b63807d806257f4e7fdd559e31341cb3594))
* some compile errors ([1e1af35](https://github.com/Proskynete/vertical-timeline-component-react/commit/1e1af35e61470f51fb898b26e59f20d0ce806bed))
* Styles ([a9f71e9](https://github.com/Proskynete/vertical-timeline-component-react/commit/a9f71e95075e247cd966a265f8d8c1c9711345f7))
* styles and funding.yml file ([9e73e6c](https://github.com/Proskynete/vertical-timeline-component-react/commit/9e73e6cd7207f274f17b593a10835251f3b64b78))
* Styles when lang as '_' or '-' symbols ([cdc8a08](https://github.com/Proskynete/vertical-timeline-component-react/commit/cdc8a08f332eba6c60c78f86d770288f4cb13d87))
* **title-overlap:** fix title styles ([29a70fc](https://github.com/Proskynete/vertical-timeline-component-react/commit/29a70fc57753ded2ebbd6b833cf22f5ce3c0428e))
* titles width ([c284e6e](https://github.com/Proskynete/vertical-timeline-component-react/commit/c284e6e9e1547b37eb12f47c2b67a304d613776f))

## [4.4.2](https://github.com/Proskynete/vertical-timeline-component-react/compare/v4.3.4...v4.4.2) (2023-01-24)


### Bug Fixes

* husky, lint-staged and lint-commit config ([b881104](https://github.com/Proskynete/vertical-timeline-component-react/commit/b881104ec1f8a6b9c19bc197dc29583b3d6a7d21))
* readme documentation ([6fbc62f](https://github.com/Proskynete/vertical-timeline-component-react/commit/6fbc62f9704c8d90f3280fa8a082dc349e9d84ba))

156 changes: 78 additions & 78 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ This is the wrapper component that creates the vertical timeline.

- Props

| name | Type | Required | Values Allowed | default values | Description |
| ---------- | ------- | -------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| theme | `object` | `false` | `colors` | { borderDotColor: '#ffffff', descriptionColor: '#cccccc', dotColor: '#c5c5c5', eventColor: '#cccccc', lineColor: '#c5c5c5', subtitleColor: '#c5c5c5', titleColor: '#cccccc', yearColor: '#888888' } | Set colors in all components |
| lang | `string` | `false` | `en`, `es`, `de`, `tr` or `zh` | `en` | Change the language `from` and `to` texts and change the format in the dates |
| dateFormat | `string` | `false` | `only-number`, `short`, `with-weekday` or `full` | `only-number` | Change the presentation format of dates |
| collapse | `boolean` | `false` | `true` or `false` | `false` | Allow collapsing description of all Content components |
| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates of all Content components |
| name | Type | Required | Values Allowed | default values | Description |
| ---------- | --------- | -------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| theme | `object` | `false` | `colors` | { borderDotColor: '#ffffff', descriptionColor: '#cccccc', dotColor: '#c5c5c5', eventColor: '#cccccc', lineColor: '#c5c5c5', subtitleColor: '#c5c5c5', titleColor: '#cccccc', yearColor: '#888888' } | Set colors in all components |
| lang | `string` | `false` | `en`, `es`, `de`, `tr` or `zh` | `en` | Change the language `from` and `to` texts and change the format in the dates |
| dateFormat | `string` | `false` | `only-number`, `short`, `with-weekday` or `full` | `only-number` | Change the presentation format of dates |
| collapse | `boolean` | `false` | `true` or `false` | `false` | Allow collapsing description of all Content components |
| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates of all Content components |

`dateFormat`: The next table shows the different formats that can be used in the `dateFormat` prop and the result that will be displayed.

Expand All @@ -89,14 +89,14 @@ This component is the container of the content of each year. It is required to h

- Props

| Name | Type | Required | Values Allowed | default values | Description |
| ------------- | ------- | -------- | --------------------------------- | -------------- | -------------------------------------------------------------------------------- |
| title | `string`, `JSX.Element` | `true` | any string, or some component | does not apply | The title of this block time |
| startDate | `string` | `true` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the start of the content or contents |
| endDate | `string` | `false` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the end of the content or contents |
| active | `boolean` | `false` | `true` or `false` | `false` | The value is the current year, it is recommended to use it in the last Container |
| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates for this component only |
| defaultClosed | `boolean` | `false` | `true` or `false` | `false` | Will collapse the content of this component only |
| Name | Type | Required | Values Allowed | default values | Description |
| ------------- | ----------------------- | -------- | --------------------------------- | -------------- | -------------------------------------------------------------------------------- |
| title | `string`, `JSX.Element` | `true` | any string, or some component | does not apply | The title of this block time |
| startDate | `string` | `true` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the start of the content or contents |
| endDate | `string` | `false` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the end of the content or contents |
| active | `boolean` | `false` | `true` or `false` | `false` | The value is the current year, it is recommended to use it in the last Container |
| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates for this component only |
| defaultClosed | `boolean` | `false` | `true` or `false` | `false` | Will collapse the content of this component only |

<p align="right"><a href="#top">🔝</a></p>

Expand All @@ -106,10 +106,10 @@ For each `Events` you need one or more `Event` component.

- Props

| Name | Type | Required | Description |
| ----------- | ---------------- | -------- | ---------------------------------------------------------------------------------- |
| title | `string` | `false` | It's the title of one or many descriptions |
| description | `array` of `strings` | `true` | You can write anything you want, but remember that it is consistent with the title |
| Name | Type | Required | Description |
| ----------- | -------------------- | -------- | ---------------------------------------------------------------------------------- |
| title | `string` | `false` | It's the title of one or many descriptions |
| description | `array` of `strings` | `true` | You can write anything you want, but remember that it is consistent with the title |

> If the title is not defined (or empty), the description will always be displayed even when the defaultClosed prop is in the Events component

Expand All @@ -125,38 +125,38 @@ The following snippet will show you how to use the library:
import { Timeline, Events, Event } from 'vertical-timeline-component-react';

const customTheme = {
borderDotColor: '#ffffff',
descriptionColor: '#262626',
dotColor: '#d0cdc4',
eventColor: '#965500',
lineColor: '#d0cdc4',
subtitleColor: '#7c7c7c',
titleColor: '#405b73',
yearColor: '#405b73',
borderDotColor: '#ffffff',
descriptionColor: '#262626',
dotColor: '#d0cdc4',
eventColor: '#965500',
lineColor: '#d0cdc4',
subtitleColor: '#7c7c7c',
titleColor: '#405b73',
yearColor: '#405b73',
};

class Main extends Component {
render() {
return (
<Timeline lang="en" theme={customTheme} dateFormat="only-number" collapse withoutDay>
<Events
title={<a href="#">What is lorem Ipsum?</div>}
subtitle="It's a fake text"
startDate="2020/12/02"
defaultClosed
active
>
<Event
title="Lorem Ipsum"
description={[
"Is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard",
'Is simply dummy text of the printing and typesetting industry.',
]}
/>
</Events>
</Timeline>
);
}
render() {
return (
<Timeline lang="en" theme={customTheme} dateFormat="only-number" collapse withoutDay>
<Events
title={<a href="#">What is lorem Ipsum?</a>}
subtitle="It's a fake text"
startDate="2020/12/02"
defaultClosed
active
>
<Event
title="Lorem Ipsum"
description={[
"Is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard",
'Is simply dummy text of the printing and typesetting industry.',
]}
/>
</Events>
</Timeline>
);
}
}
```

Expand All @@ -166,36 +166,36 @@ class Main extends Component {
import { Timeline, Events, Event } from 'vertical-timeline-component-react';

const Main = () => {
const customTheme = {
borderDotColor: '#ffffff',
descriptionColor: '#262626',
dotColor: '#d0cdc4',
eventColor: '#965500',
lineColor: '#d0cdc4',
subtitleColor: '#7c7c7c',
titleColor: '#405b73',
yearColor: '#405b73',
};

return (
<Timeline lang="en" theme={customTheme} dateFormat="only-number" collapse withoutDay>
<Events
title="What is lorem Ipsum?"
subtitle="It's a fake text"
startDate="2020/12/02"
active
defaultClosed
>
<Event
title="Lorem Ipsum"
description={[
"Is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard",
'Is simply dummy text of the printing and typesetting industry.',
]}
/>
</Events>
</Timeline>
);
const customTheme = {
borderDotColor: '#ffffff',
descriptionColor: '#262626',
dotColor: '#d0cdc4',
eventColor: '#965500',
lineColor: '#d0cdc4',
subtitleColor: '#7c7c7c',
titleColor: '#405b73',
yearColor: '#405b73',
};

return (
<Timeline lang="en" theme={customTheme} dateFormat="only-number" collapse withoutDay>
<Events
title="What is lorem Ipsum?"
subtitle="It's a fake text"
startDate="2020/12/02"
active
defaultClosed
>
<Event
title="Lorem Ipsum"
description={[
"Is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard",
'Is simply dummy text of the printing and typesetting industry.',
]}
/>
</Events>
</Timeline>
);
};
```

Expand Down
Loading