Skip to content
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.

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

merge next to master #2

Merged
merged 70 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
754f4c9
[update] initial info added
tbshag2 Aug 2, 2024
0776562
[update] initial info to configuration, laoding_data, localization ad…
tbshag2 Aug 9, 2024
86d007a
[update] sidebar fixed
tbshag2 Aug 9, 2024
5034af5
[update] cardshape infoshape updated
tbshag2 Aug 13, 2024
ab0f10a
[update] pages renamed to appropr format
tbshag2 Aug 15, 2024
828dc8a
Merge branch 'master' into next
mkozhukh Aug 16, 2024
260c791
[update] slotsize, slotgap added, getstate updated
tbshag2 Aug 19, 2024
4c99125
Merge branch 'next' of https://github.com/DHTMLX/docs-booking into next
tbshag2 Aug 19, 2024
60ce632
[update] events info added
tbshag2 Aug 30, 2024
f7109d7
[update] events info updated
tbshag2 Aug 30, 2024
6df1efa
[update] filtershape added
tbshag2 Aug 30, 2024
a4ef58f
Update README.md
tbshag2 Aug 30, 2024
531db40
[update] formshape and confirmslot updated
tbshag2 Sep 5, 2024
3bd1e4b
Merge branch 'next' of https://github.com/DHTMLX/docs-booking into next
tbshag2 Sep 5, 2024
a89008d
[update] data, filtershape, formatshape, infoshape, confirmslot, filt…
tbshag2 Sep 6, 2024
6d58a24
[update] filtershape and configuration guides updated
tbshag2 Sep 9, 2024
4abadc4
[update] how-to-start added, initialization updated, filtershape updated
tbshag2 Sep 10, 2024
3c16f27
[update] events, internal method, loading_data, configuration, locali…
tbshag2 Sep 12, 2024
32f8148
[update] configuration updated
tbshag2 Sep 17, 2024
38676c5
[update] localization updated, styling added
tbshag2 Sep 18, 2024
e91d1e4
[update] localization updated, locale, setlocale added
tbshag2 Sep 19, 2024
36d3b10
[update] localization updated, locale, setlocale added
tbshag2 Sep 19, 2024
dbf6c0c
[update] UI overview added
tbshag2 Sep 20, 2024
dbd0782
[update] examples corrected, links fixed, overview pages added
tbshag2 Sep 25, 2024
69d5d0a
[update] styling updated
tbshag2 Sep 30, 2024
5178bf3
[update] detach added, configuration updated
tbshag2 Oct 7, 2024
9a49720
[update] link fixed
tbshag2 Oct 8, 2024
cfca6ae
[update] localization, configuration, properties, confirmslot, interc…
tbshag2 Oct 9, 2024
9ef0189
[update] localization updated
tbshag2 Oct 9, 2024
bf03adc
[update] detach, serialize, setconfig, setconfirmhansler, saving-rese…
tbshag2 Oct 10, 2024
3d1a966
[update] localization updated
tbshag2 Oct 10, 2024
8f3fb23
[update] setconfirmhandler updated
tbshag2 Oct 10, 2024
919c163
[update] setconfirmhandler updated
tbshag2 Oct 10, 2024
c8064a8
[update] detach added
tbshag2 Oct 10, 2024
31ee3f0
[update] detach added
tbshag2 Oct 10, 2024
ad8a01f
[update] detach updated
tbshag2 Oct 10, 2024
3880b03
[update] images added to index
tbshag2 Oct 10, 2024
675c873
[update] overviews updated with links, slotlimit added
tbshag2 Oct 11, 2024
8cde528
[update] setnext example fixed
tbshag2 Oct 11, 2024
8c7c5a7
[update] lang added to locales, links fixed
tbshag2 Oct 11, 2024
255799b
[update] locales updated
tbshag2 Oct 11, 2024
9304e36
[update] locales updated, links to snippets added, configuration updated
tbshag2 Oct 16, 2024
a16ee70
[update] cardshape updated
tbshag2 Oct 16, 2024
06f7238
[update] data formatting fixed
tbshag2 Oct 16, 2024
a7cc8ed
[update] loading updated, images changed
tbshag2 Oct 16, 2024
0e56559
[update] loading updated
tbshag2 Oct 16, 2024
4bb2c3a
[update] images updated
tbshag2 Oct 16, 2024
5d441ad
[update] images updated
tbshag2 Oct 16, 2024
9bfdece
[update] how-to-start updated
tbshag2 Oct 16, 2024
0391743
[update] how-to-start updated
tbshag2 Oct 16, 2024
89395d3
[update] loadin-data updated
tbshag2 Oct 16, 2024
0d2d46f
[update] whats_new updated
tbshag2 Oct 16, 2024
51eda3e
[update] whats_new updated
tbshag2 Oct 16, 2024
4cf4fa2
[update] whats_new updated
tbshag2 Oct 16, 2024
edc2a40
[dev] correct whatsnew and data
Oct 19, 2024
bae012f
[update] corrected misprints
tbshag2 Oct 28, 2024
2363cd9
Merge branch 'next' of https://github.com/DHTMLX/docs-booking into next
tbshag2 Oct 28, 2024
c64b79f
[update] corrected misprints
tbshag2 Oct 28, 2024
d6807df
[update] corrected misprints
tbshag2 Oct 28, 2024
ac8c4e2
[update] locales updated
tbshag2 Oct 30, 2024
595531e
[update] overview updated, images fixed
tbshag2 Oct 31, 2024
8bd5561
[update] images fixed
tbshag2 Oct 31, 2024
00e6d81
[update] images fixed
tbshag2 Oct 31, 2024
51ae516
[update] start, end props added, configuration updated
tbshag2 Nov 1, 2024
43e8aab
[update] readme updated
tbshag2 Nov 1, 2024
1ad6662
[dev] Add local search. Update engine to v3.6.0
serhiipylypchuk1991 Nov 6, 2024
3862013
[update] style changes
serhiipylypchuk1991 Nov 6, 2024
6044562
Merge pull request #1 from DHTMLX/sp-next-refactor
tbshag2 Nov 6, 2024
5b56005
[update] merged with sp-next-factor branch, links fixed, release date…
tbshag2 Nov 6, 2024
116470c
[update] readme updated
tbshag2 Nov 6, 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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center"><a href="https://docs.dhtmlx.com/booking/">DHTMLX Booking Documentation</a></h1>
<h1 align="center"><a href="https://docs-next.dhtmlx.com/booking/">DHTMLX Booking Documentation</a></h1>

New Booking description here
JavaScript Booking library is a ready-made component designed to be easily incorporated into your application. It provides end-users with functionality for scheduling appointments online with wide search options. The widget is made responsive and optimised for mobile devices.

## Explore documentation locally

Expand All @@ -27,13 +27,13 @@ $ yarn start

## Related sources

[Download DHTMLX Booking](https://dhtmlx.com/docs/products/dhtmlxBooking/download.shtml)
[Download DHTMLX Booking](https://dhtmlx.com/docs/products/dhtmlxBooking/)

[Live demos](https://snippet.dhtmlx.com/)
[Live demos](https://snippet.dhtmlx.com/d7w3jtqz?tag=booking)

[Blog](https://dhtmlx.com/blog/)

[Forum](https://forum.dhtmlx.com/)
[Forum](https://forum.dhtmlx.com/c/widgets/)

## Follow us

Expand All @@ -47,4 +47,4 @@ Follow us on [Twitter](https://twitter.com/dhtmlx) :feet:

Like our page on [Facebook](https://www.facebook.com/dhtmlx/) :thumbsup:

See our news on [Linkedin](https://www.linkedin.com/groups/3345009/) :mega:
See our news on [Linkedin](https://www.linkedin.com/groups/3345009/) :mega:
69 changes: 0 additions & 69 deletions docs/api/api_overview.md

This file was deleted.

70 changes: 70 additions & 0 deletions docs/api/config/booking-cardshape.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
sidebar_label: cardShape
title: cardShape
description: You can learn about the cardShape config in the documentation of the DHTMLX JavaScript Booking library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Booking.
---

# cardShape

### Description

@short: Optional. An object with settings for managing information displayed on the left side of cards

### Usage

~~~jsx {}
cardShape?: {
category?: boolean,
details?: boolean,
preview?: boolean,
price?: boolean,
review?: boolean,
subtitle?: boolean,
title?: boolean
};
~~~

### Parameters

To configure the card appearance, in the **cardShape** object you can specify the following parameters (fields):

- `category` - (optional) shows/hides a card's name
- `details` - (optional) shows/hides details
- `preview` - (optional) shows/hides a preview image
- `price` - (optional) shows/hides price
- `review` - (optional) shows/hides rating information
- `subtitle` - (optional) shows/hides a card's subtitle
- `title` - (optional) shows/hides a card's title

### Default config

~~~jsx {}
const defaultCardShape = {
category: true,
details: true,
preview: true,
price: true,
review: true,
subtitle: false,
title: true
};
~~~

### Example

~~~jsx {}
const cardShape = {
review: false,
subtitle: false,
price: false
};

new booking.Booking("#root", {
cardShape,
// other parameters
});
~~~

The snippet below demonstrates how to configure what to display on the left side of cards:

<iframe src="https://snippet.dhtmlx.com/6mxd7918?mode=result" frameborder="0" class="snippet_iframe" width="100%" height="600"></iframe>
140 changes: 140 additions & 0 deletions docs/api/config/booking-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
---
sidebar_label: data
title: data
description: You can learn about the cards config in the documentation of the DHTMLX JavaScript Booking library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Booking.
---

# data

### Description

@short: Optional. An array of objects containing the cards data

### Usage

~~~jsx {}
data: [
{
id: string | number,
title: string,
category?: string,
subtitle?: string,
details?: string,
preview?: string, // link to image
price?: string,
review?: {
stars: number,
count: number
},
slots: [
{
from: number | string, // hours from 0 to 24
to: number | string, // hours from 0 to 24
size?: number, // length of slot in minutes
gap?: number, // gap between slots in minutes
days?: array, // days of week for which rule can be applied from 0 to 6
dates?: array, // exact dates for which rule can be applied, timestamps
}
],
availableSlots?: [
{
id: string|number,
time:[number, number] //timestamp, length in minutes
},
],
usedSlots?: number[], //timestamps
slotSize?: number, //minutes
slotGap?: number //minutes
}
];
~~~

### Parameters

For each card object you can specify the following parameters:

- `id` - (required) the ID of a card
- `title` - (required) the title of a card (e.g., a specialist's name)
- `category` - (optional) the category name of a card (e.g., a specialist's job)
- `subtitle` - (optional) the subtitle of a card
- `details` - (optional) other details of a card
- `preview` - (optional) a card preview which is the link to the card image
- `price` - (optional) the price of the service
- `review` - (optional) rating information that includes the following parameters:
- `stars` - (optional) the number of rating stars (out of five)
- `count` - (optional) the number of reviews
- `slots` - (required) an array of objects with the following parameters for each slot object:
- `from` - (required) a slot start time in hours from 0 to 24
- `to` - (required) a slot end time in hours from 0 to 24
- `size` - (optional) the duration of one slot in minutes
- `gap` - (optional) the gap between slots in minutes; 0 is set by default
- `days` - (optional) days of the week when a slot is available for booking; possible values: from 0 to 6 where 0 is Sunday and 6 is Saturday; if no days are specified, all days are applied by default; if days are specified, the slot parameters (**to**, **from**, **size**, **gap**) defined for these days will be applied
- `dates` - (optional) an array of timestamps in milliseconds which are exact dates when a slot is available; the slot parameters (**to**, **from**, **size**, **gap**) for these specified dates will be applied

:::note
Slot parameters specified for days will override common parameters defined for all days.
Slot parameters specified for dates will override parameters defined for specific days and all days.
If several slots objects are created for the same day, make sure that slots time ranges (from and to) with **different** size and gap do not overlap, otherwise all slots data for these days will not be applied.
:::

- `availableSlots` - (optional) an array of timestamps of available slots in milliseconds; if available slots are specified here, all slots from the `slots` array are ignored (i.e., become unavailable); each object in the array has the next parameters:
- `id` - (required) the id of a slot
- `time` - (required) an array that includes timestamp and slot duration in minutes
- `usedSlots` - (optional) an array of timestamps of booked slots in milliseconds
- `slotSize` - (optional) the duration of a slot in minutes; the value will be applied to all slots of this card if other value is not set inside the `slots` object; *60* minutes is set by default
- `slotGap` - (optional) the gap between slots in minutes that is set for all slots in the current card; this value is applied if any other value is not specified inside the `slots` object; 0 is set by default

### Example

~~~jsx {}
const data = [
{
id: "5cf364d8-9997-4d8c-9586-48f90f3cb736",
title: "Debra Weeks",
category: "Allergist",
subtitle: "7 years of experience",
details:
"Silverstone Medical Center (Vanderbilt Avenue 13, Chestnut, New Zealand)",
preview: "https://snippet.dhtmlx.com/codebase/data/booking/01/img/01.jpg",
price: "37 $",
review: {
star: 1,
count: 40
},
slots: [
{
//a common slot rule for all days except those specified for the days and dates below
from: 14,
to: 17,
size: 30,
gap: 10
},
{
//this rule is applied to days 2 and 5 (Tuesdays and Fridays) except
//the Friday from the slot object below
from: 12,
to: 17,
size: 50,
gap: 20,
days: [2, 5]
},
{
//this rule is applied to days 3 and 4 (Wednesdays and Thursdays) and exact date
from: 18,
to: 20,
size: 45,
gap: 20,
days: [3, 4],
dates: [ 1683234000000 ] // exact upcoming date (May 5, 2023, Friday)
}
]
}
];

new booking.Booking("#root", {
data,
// other parameters
});
~~~

**Related articles:** [Defining slot rules](/guides/configuration#defining-slot-rules)
35 changes: 35 additions & 0 deletions docs/api/config/booking-end.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_label: end
title: end
description: You can learn about the end date in the documentation of the DHTMLX JavaScript Booking library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Booking.
---

# end

### Description

@short: Optional. Defines the date until which to show available slots

### Usage

~~~jsx {}
end?: Date;
~~~

### Parameters

- `Date` - the end date until which to display available slots; the default value is one year from the current date.

### Example

~~~jsx {}
new booking.Booking("#root", {
data,
end: new Date(2025, 11, 11),
// other parameters
});
~~~

The snippet below shows how to set the [start](/api/config/booking-start) and end dates:

<iframe src="https://snippet.dhtmlx.com/cc28whe7?mode=result" frameborder="0" class="snippet_iframe" width="100%" height="600"></iframe>
Loading
Loading