<commit_before><h1 class="doc-page-title">API Reference</h1>

<p>
  Lorem ipsum dolor sit amet, consectetur adipisicing elit. Obcaecati maxime facere magni vitae exercitationem dolor nam quo, eius laborum cumque ab, similique voluptatem excepturi fugit ut earum qui. Impedit, sapiente.
</p><commit_msg>Start documenting the public API<commit_after><h1 class="doc-page-title">API Reference</h1>

<p>
  Ember Power Calendar aims to allow users to create the ideal calendar they need
  using only the properties and actions defined in its public API, so it is important
  to have a comprehensive list of all the available options.
</p>

<h3>The <code>day</code> object</h3>

<p>
  The day object is an object receibed by many actions, blocks and components and one of the
  interfaces you will use more often.
</p>

<table>
  <thead>
    <tr>
      <th>Option</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>id</td>
      <td><code>String</code></td>
      <td>A unique identified of the day. It has the format <code>YYYY-MM-DD</code></td>
    </tr>
    <tr>
      <td>number</td>
      <td><code>Number</code></td>
      <td>The day's number. From 1 to 31</td>
    </tr>
    <tr>
      <td>date</td>
      <td><code>Date</code></td>
      <td>The native <code>Date</code> object representing that day.</td>
    </tr>
    <tr>
      <td>moment</td>
      <td><code>MomentJS</code></td>
      <td>The <code>moment</code> representing that day.</td>
    </tr>
    <tr>
      <td>isFocused</td>
      <td><code>Boolean</code></td>
      <td>It is true when the the cell of that day has the focus</td>
    </tr>
    <tr>
      <td>isCurrentMonth</td>
      <td><code>Boolean</code></td>
      <td>It is true for those days in the current day, and false for those days for the previous/next months shown around.</td>
    </tr>
    <tr>
      <td>isToday</td>
      <td><code>Boolean</code></td>
      <td>It is true if this day is today</td>
    </tr>
    <tr>
      <td>isSelected</td>
      <td><code>Boolean</code></td>
      <td>It is true if the date of this day is the selected one. In multiple select it is true if the date of this day is among the selected ones. In range selects, it is true if the date if this day is in the range, including both ends.</td>
    </tr>
    <tr>
      <td>isRangeStart</td>
      <td><code>Boolean</code></td>
      <td>It is true if this day is the beginning of a range. It is false in non-range calendars</td>
    </tr>
    <tr>
      <td>isRangeEnd</td>
      <td><code>Boolean</code></td>
      <td>It is true if this day is the end of a range. It is false in non-range calendars</td>
    </tr>
  </tbody>
</table>

<h3>The <code>calendar</code> object</h3>


{'fraction_non_alphanumeric': 0.14223353946889777, 'fraction_numerical': 0.004001455074572572, 'mean_word_length': 2.7774725274725274, 'pattern_counts': {'":': 0, '<': 141, '<?xml version=': 0, '>': 141, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3870850', 'n_tokens_mistral': 960, 'n_tokens_neox': 945, 'n_words': 321}